de.softdevel.d1.id

Interface IId

All Known Implementing Classes:

CIdInvalid

public interface IId

The ID (Namespace Id). The ID can be an Integer, an UUID or a String (and perhaps more later). IDs are created by the CIdFactory. They are components of Addresses and widely used for Messaging.

Field Summary

Fields

Modifier and Type	Field and Description
static IId	INVALID An invalid ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object aOther)
EIdType	getType()
int	hashCode()
boolean	isValid() Validity of a IId.
void	toStream(java.io.DataOutputStream aStream) Put the object into the stream.
java.lang.String	valueToString()

Field Detail

INVALID

static final IId INVALID

An invalid ID.

Method Detail

equals

boolean equals(java.lang.Object aOther)

Overrides:

equals in class java.lang.Object

getType

EIdType getType()

Returns:

The type of the IId (Integer, UUID, String...).

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

isValid

boolean isValid()

Validity of a IId. This depends from the type of the IId: - Integer: not 0 (but negative values are okay) - UUID: not null, not CUtilUuid.UUID_INVALID - String: not null and not empty In most cases the system will create an instance of CIdInvalid instead of invalid CIdInteger/CIdUuid/CIdString.

Returns:

True if the IId is not invalid.

toStream

void toStream(java.io.DataOutputStream aStream)
       throws java.io.IOException

Put the object into the stream.

Parameters:

aStream - The stream.

Throws:

java.io.IOException - on error

valueToString

java.lang.String valueToString()

Returns:

The complete String which represents the ID value.