info.pppc.base.system

Class ObjectID

java.lang.Object

info.pppc.base.system.ObjectID

All Implemented Interfaces:

ISerializable

public final class ObjectID
extends java.lang.Object
implements ISerializable

The ObjectID identifies a unique object on a certain system. This means that ObjectIDs are used to identify a globally unique object.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION The abbreviation used for this class during serialization.

Constructor Summary

Constructors

Constructor and Description
ObjectID() Generates a new uninitialized object id.
ObjectID(long value) Generates a new well known object id.

Method Summary

Methods

Modifier and Type	Method and Description
static ObjectID	create() Creates a new globally unique object id.
boolean	equals(java.lang.Object object) Compares the specified object with this id for equality.
int	hashCode() Returns the hash code of the id.
boolean	isKnown() Determines whether this object id represents a well known object id.
void	readObject(IObjectInput input) Reads the ObjectID from a stream.
java.lang.String	toString() Returns a string representation of this UID.
void	writeObject(IObjectOutput stream) Writes the ObjectID to the given stream.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ABBREVIATION

public static final java.lang.String ABBREVIATION

The abbreviation used for this class during serialization.

See Also:

Constant Field Values

Constructor Detail

ObjectID

public ObjectID()

Generates a new uninitialized object id. This constructor is intended for deserialization only. It must not be called from user code. To create a new and globally unique id, a user must call the create method.

ObjectID

public ObjectID(long value)

Generates a new well known object id. The value set as parameter must be non-negative, otherwise this method will throw an illegal argument exception. Search for references to this constructor to find the well known object ids that have been assigned already.

Parameters:

value - The id of the well known object id.

Method Detail

create

public static ObjectID create()

Creates a new globally unique object id.

Returns:

A new globally unique object id.

hashCode

public int hashCode()

Returns the hash code of the id.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code of the id.

isKnown

public boolean isKnown()

Determines whether this object id represents a well known object id.

Returns:

True if the object id is a well known object id.

equals

public boolean equals(java.lang.Object object)

Compares the specified object with this id for equality.

Overrides:

equals in class java.lang.Object

Parameters:

object - The object to compare to.

Returns:

True if the object id equals the given object. False otherwise.

toString

public java.lang.String toString()

Returns a string representation of this UID.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this UID

writeObject

public void writeObject(IObjectOutput stream)
                 throws java.io.IOException

Writes the ObjectID to the given stream.

Specified by:

writeObject in interface ISerializable

Parameters:

stream - The stream to write to.

Throws:

java.io.IOException - If writing to the stream caused an exception.

readObject

public void readObject(IObjectInput input)
                throws java.io.IOException

Reads the ObjectID from a stream.

Specified by:

readObject in interface ISerializable

Parameters:

input - The stream to read from.

Throws:

java.io.IOException - Thrown if reading caused this exception.