com.metamatrix.core.id
Interface ObjectID

All Superinterfaces:

java.lang.Comparable

All Known Implementing Classes:

IntegerID, LongID, StringID, UUID

public interface ObjectID
extends java.lang.Comparable

Field Summary

static char

DELIMITER

Method Summary

int	compareTo(java.lang.Object obj) Compares this object to another.
java.lang.String	getProtocol() Return the name of the protocol that this factory uses.
java.lang.String	toString() Returns a string representing the current state of the object.
java.lang.String	toString(char delim) Returns a string representing the current state of the object.

Field Detail

DELIMITER

static final char DELIMITER

See Also:

Constant Field Values

Method Detail

compareTo

int compareTo(java.lang.Object obj)

Compares this object to another. If the specified object is not an instance of the ObjectID class, then this method throws a ClassCastException (as instances are comparable only to instances of the same class). Note: this method is consistent with equals(), meaning that (compare(x, y)==0) == (x.equals(y)).

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - the object that this instance is to be compared to; may not be null.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object, respectively.

Throws:

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this instance.

toString

java.lang.String toString()

Returns a string representing the current state of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this instance.

toString

java.lang.String toString(char delim)

Returns a string representing the current state of the object.

Parameters:

delim - the delimiter that should be used

Returns:

the string representation of this instance.

getProtocol

java.lang.String getProtocol()

Return the name of the protocol that this factory uses.

Returns:

the protocol name