com.peterphi.std.types

Class Id

java.lang.Object

com.peterphi.std.types.Id

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Id>

Direct Known Subclasses:

SimpleId

public abstract class Id
extends java.lang.Object
implements java.lang.Comparable<Id>, java.io.Serializable

An abstract base type for a case-sensitive identifier
All implementations must directly extend this type (ie. all people who extend this type should mark their implementation as final)
It is not permitted to add any additional fields to an Id field: the sole benefit of extending an Id type is to provide clarity to what kind of Id something is
An id is never permitted to be null, nor may it be an empty String

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	id The internal value of this id; while public, this should only be required very rarely
static boolean	SANITY_CHECK If true the constructor for Id will verify that all Ids comply with the

Constructor Summary

Constructors

Constructor and Description
Id(java.lang.String id) Constructs a new id

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Id that) Compares another Id to this id.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SANITY_CHECK

public static final boolean SANITY_CHECK

If true the constructor for Id will verify that all Ids comply with the

See Also:

Constant Field Values

id

public final java.lang.String id

The internal value of this id; while public, this should only be required very rarely

Constructor Detail

Id

public Id(java.lang.String id)

Constructs a new id

Parameters:

id - the id value to use (may not be null)

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public final int compareTo(Id that)

Compares another Id to this id. Two ids are only comparable if they have the exact same type: if their types are incompatible then a ClassCastException will be thrown
If the types are comparable then the result is a case-sensitive comparison of the underlying id valued

Specified by:

compareTo in interface java.lang.Comparable<Id>

See Also:

Comparable.compareTo(java.lang.Object)

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object