Package org.eclipse.ditto.model.base.entity.id

Class DefaultNamespacedEntityId

java.lang.Object

org.eclipse.ditto.model.base.entity.id.DefaultNamespacedEntityId

All Implemented Interfaces:

CharSequence, Comparable<EntityId>, EntityId, NamespacedEntityId

@Immutable
public final class DefaultNamespacedEntityId
extends Object
implements NamespacedEntityId

Default implementation for a validated NamespacedEntityId

Method Summary

Modifier and Type	Method	Description
static NamespacedEntityId	dummy()	Returns a dummy NamespacedEntityId.
boolean	equals(Object o)
static NamespacedEntityId	fromName(String entityName)	Creates NamespacedEntityId with default namespace placeholder.
String	getName()	Gets the name part of this entity ID.
String	getNamespace()	Gets the namespace part of this entity ID.
int	hashCode()
boolean	isDummy()	Checks whether this ID acts as dummy ID.
static NamespacedEntityId	of(CharSequence entityId)	Returns a NamespacedEntityId based on the given entityId CharSequence.
static NamespacedEntityId	of(String namespace, String name)	Creates a new NamespacedEntityId with the given namespace and name.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface org.eclipse.ditto.model.base.entity.id.EntityId

charAt, compareTo, length, subSequence

Method Detail

of

public static NamespacedEntityId of(CharSequence entityId)

Returns a NamespacedEntityId based on the given entityId CharSequence. May return the same instance as the parameter if the given parameter is already a DefaultNamespacedEntityId. Skips validation if the given entityId is an instance of NamespacedEntityId.

Parameters:

entityId - the entity ID.

Returns:

the namespaced entity ID.

Throws:

NamespacedEntityIdInvalidException - if the given entityId is invalid.

fromName

public static NamespacedEntityId fromName(String entityName)

Creates NamespacedEntityId with default namespace placeholder.

Parameters:

entityName - the name of the entity.

Returns:

the created namespaced entity ID.

Throws:

NamespacedEntityIdInvalidException - if the given entityName is invalid.

of

public static NamespacedEntityId of(String namespace,
                                    String name)

Creates a new NamespacedEntityId with the given namespace and name.

Parameters:

namespace - the namespace of the entity.

name - the name of the entity.

Returns:

the created instance of NamespacedEntityId

dummy

public static NamespacedEntityId dummy()

Returns a dummy NamespacedEntityId. This ID should not be used. It can be identified by checking EntityId.isDummy().

Returns:

the dummy ID.

isDummy

public boolean isDummy()

Description copied from interface: EntityId

Checks whether this ID acts as dummy ID. Dummy IDs should not be used as ID for any entity.

Specified by:

isDummy in interface EntityId

Returns:

true if this ID is a dummy ID, otherwise false.

getName

public String getName()

Description copied from interface: NamespacedEntityId

Gets the name part of this entity ID.

Specified by:

getName in interface NamespacedEntityId

Returns:

the name if the entity.

getNamespace

public String getNamespace()

Description copied from interface: NamespacedEntityId

Gets the namespace part of this entity ID.

Specified by:

getNamespace in interface NamespacedEntityId

Returns:

the namespace o the entity.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object