net.sf.mmm.util.entity.base

Class AbstractEntityId

java.lang.Object

net.sf.mmm.util.entity.base.AbstractEntityId

All Implemented Interfaces:

Serializable, EntityId, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

Direct Known Subclasses:

EntityIdImpl

public abstract class AbstractEntityId
extends Object
implements EntityId

This is the abstract base implementation of EntityId.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID UID for serialization.

Fields inherited from interface net.sf.mmm.util.entity.api.EntityId

OBJECT_ID_ILLEGAL, OBJECT_ID_MINIMUM_CUSTOM, RADIX, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
AbstractEntityId() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getValue() This method returns the raw value of this datatype.
int	hashCode()
String	toString() The string representation of the EntityId in the following form:

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.entity.api.EntityId

getObjectId, getRevision, getTypeId

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

Constructor Detail

AbstractEntityId

public AbstractEntityId()

The constructor.

Method Detail

getValue

public String getValue()

This method returns the raw value of this datatype. This will typically be a standard datatype (like String, Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

The string representation of the EntityId in the following form:

 <objectId>.<typeId>[.<revision>]
 

The revision can be omitted if zero. All number values are encoded using the EntityId.RADIX constant.
Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface EntityId

Specified by:

toString in interface Datatype

Overrides:

toString in class Object

Returns:

the official String representation to display the value of this Datatype.