info.pppc.base.system

Class ReferenceID

java.lang.Object

info.pppc.base.system.ReferenceID

All Implemented Interfaces:

ISerializable

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

A reference identifier represents a remote object reference. It contains a system identifier that denotes the location and an object identifier that denotes the 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
ReferenceID() Creates a new empty reference.
ReferenceID(SystemID system) Creates a new reference that points to the specified system.
ReferenceID(SystemID system, ObjectID object) Creates a new reference to the specified object at the specified location.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines whether two reference identifiers are equal.
ObjectID	getObject() Returns the identity of the referenced object.
SystemID	getSystem() Returns the location of the referenced object.
int	hashCode() Returns a hash code for the reference id that is based on its system id and object id.
boolean	isEmpty() Determines whether the reference points to anything else than null.
void	readObject(IObjectInput input) Reads the reference identifier from the stream.
void	setObject(ObjectID object) Sets the identity of the referenced object.
void	setSystem(SystemID system) Sets the location of the referenced object.
java.lang.String	toString() Returns a string representation.
void	writeObject(IObjectOutput output) Writes the reference identifier 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

ReferenceID

public ReferenceID()

Creates a new empty reference. This constructor should only be used for serialization purposes.

ReferenceID

public ReferenceID(SystemID system)

Creates a new reference that points to the specified system.

Parameters:

system - The location of the registry.

ReferenceID

public ReferenceID(SystemID system,
           ObjectID object)

Creates a new reference to the specified object at the specified location.

Parameters:

system - The location of the object.

object - The identity of the object.

Method Detail

isEmpty

public boolean isEmpty()

Determines whether the reference points to anything else than null.

Returns:

True if system or object id are not null, false otherwise.

getSystem

public SystemID getSystem()

Returns the location of the referenced object.

Returns:

The location of the object.

setSystem

public void setSystem(SystemID system)

Sets the location of the referenced object.

Parameters:

system - The location of the object.

getObject

public ObjectID getObject()

Returns the identity of the referenced object.

Returns:

The identity of the object.

setObject

public void setObject(ObjectID object)

Sets the identity of the referenced object.

Parameters:

object - The identity of the object.

readObject

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

Reads the reference identifier from the stream.

Specified by:

readObject in interface ISerializable

Parameters:

input - The stream to read from.

Throws:

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

writeObject

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

Writes the reference identifier to the given stream.

Specified by:

writeObject in interface ISerializable

Parameters:

output - The stream to write to.

Throws:

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

toString

public java.lang.String toString()

Returns a string representation.

Overrides:

toString in class java.lang.Object

Returns:

A string representation.

hashCode

public int hashCode()

Returns a hash code for the reference id that is based on its system id and object id.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code for the reference id.

equals

public boolean equals(java.lang.Object obj)

Determines whether two reference identifiers are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare to.

Returns:

True if they are equal, false otherwise.