org.datanucleus.identity
Interface OID

All Known Implementing Classes:

DatastoreUniqueOID, OIDImpl, OIDImpl2, OIDImpl3

public interface OID

Interface for a datastore-identity class to implement. Please refer to the JDO2 specification 5.4.3 for precise requirements of such a class. These include

• Has to implement Serializable
• Serializable fields have to be public
• Has to have a constructor taking a String (the same String that toString() returns)

Version:

$Revision: 1.1 $

Method Summary

boolean	equals(java.lang.Object obj) Equality operator.
java.lang.Object	getKeyValue() Provides the OID in a form that can be used by the database as a key.
java.lang.String	getPcClass() Accessor for the PC class name
int	hashCode() Accessor for the hashcode
java.lang.String	toString() Returns the string representation of the OID.

Method Detail

getKeyValue

java.lang.Object getKeyValue()

Provides the OID in a form that can be used by the database as a key.

Returns:

The key value

getPcClass

java.lang.String getPcClass()

Accessor for the PC class name

Returns:

the PC Class

equals

boolean equals(java.lang.Object obj)

Equality operator.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to compare against

Returns:

Whether they are equal

hashCode

int hashCode()

Accessor for the hashcode

Overrides:

hashCode in class java.lang.Object

Returns:

Hashcode for this object

toString

java.lang.String toString()

Returns the string representation of the OID. The string representation should contain enough information to be usable as input to a String constructor to create the OID.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the OID.