org.wikidata.wdtk.datamodel.implementation

Class AliasUpdateImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.AliasUpdateImpl

All Implemented Interfaces:

AliasUpdate

public class AliasUpdateImpl
extends Object
implements AliasUpdate

Jackson implementation of AliasUpdate.

Field Summary

Fields inherited from interface org.wikidata.wdtk.datamodel.interfaces.AliasUpdate

EMPTY

Constructor Summary

Constructors

Constructor and Description
AliasUpdateImpl(List<MonolingualTextValue> recreated, List<MonolingualTextValue> added, Collection<MonolingualTextValue> removed) Initializes new alias update.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<MonolingualTextValue>	getAdded() Returns aliases added in this update.
Optional<String>	getLanguageCode() Returns language code of aliases in this update.
Optional<List<MonolingualTextValue>>	getRecreated() Returns the new list of aliases that completely replaces current aliases.
Set<MonolingualTextValue>	getRemoved() Returns aliases removed in this update.
int	hashCode()
boolean	isEmpty() Checks whether the update is empty.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AliasUpdateImpl

public AliasUpdateImpl(List<MonolingualTextValue> recreated,
                       List<MonolingualTextValue> added,
                       Collection<MonolingualTextValue> removed)

Initializes new alias update. This update applies to aliases in one language only. Callers should specify either recreated parameter or added and removed parameters, because combination of the two update approaches is not possible. To remove all aliases, pass empty list in recreated parameter.

Parameters:

recreated - new list of aliases that completely replaces the old ones or null to not recreate aliases

added - aliases added in this update or empty collection for no additions

removed - aliases removed in this update or empty collection for no removals

Throws:

NullPointerException - if added, removed, or any alias is null

IllegalArgumentException - if given invalid combination of parameters

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: AliasUpdate

Checks whether the update is empty. Empty update will not alter alias list in any way.

Specified by:

isEmpty in interface AliasUpdate

Returns:

true if the update is empty, false otherwise

getLanguageCode

public Optional<String> getLanguageCode()

Description copied from interface: AliasUpdate

Returns language code of aliases in this update. Language code is only available for non-empty updates.

Specified by:

getLanguageCode in interface AliasUpdate

Returns:

alias language code or Optional.empty() when the update is empty

getRecreated

public Optional<List<MonolingualTextValue>> getRecreated()

Description copied from interface: AliasUpdate

Returns the new list of aliases that completely replaces current aliases. If this list is present, then the update contains no added/removed aliases.

Specified by:

getRecreated in interface AliasUpdate

Returns:

new list of aliases or Optional.empty() if aliases are not being recreated

getAdded

public List<MonolingualTextValue> getAdded()

Description copied from interface: AliasUpdate

Returns aliases added in this update. If there are any added aliases, then AliasUpdate.getRecreated() must return Optional.empty(). It is however possible to add and remove aliases in the same update.

Specified by:

getAdded in interface AliasUpdate

Returns:

added aliases

getRemoved

public Set<MonolingualTextValue> getRemoved()

Description copied from interface: AliasUpdate

Returns aliases removed in this update. If there are any removed aliases, then AliasUpdate.getRecreated() must return Optional.empty(). It is however possible to add and remove aliases in the same update.

Specified by:

getRemoved in interface AliasUpdate

Returns:

removed aliases

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object