org.datanucleus.identity
Class OIDImpl

java.lang.Object
  org.datanucleus.identity.OIDImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, OID

public class OIDImpl
extends java.lang.Object
implements java.io.Serializable, OID, java.lang.Comparable

An object identifier, typically used for datastore identity. The behaviour of this class is governed by JDO spec 5.4.3. Utilises a String form of the style "3258[OID]mydomain.MyClass".

See Also:

Serialized Form

Field Summary

int	hashCode pre-created hasCode to improve performance
protected static Localiser	LOCALISER Localiser for messages.
java.lang.Object	oid The key value.
java.lang.String	pcClass The PersistenceCapable class name
java.lang.String	toString pre-created toString to improve performance

Constructor Summary

OIDImpl()
Creates an OID with no value.

OIDImpl(java.lang.String str)
Constructs an OID from its string representation that is consistent with the output of toString().

OIDImpl(java.lang.String pcClass, java.lang.Object object)
Create a string datastore identity.

Method Summary

int	compareTo(java.lang.Object o) Comparator method.
boolean	equals(java.lang.Object obj) Equality operator.
java.lang.Object	getKeyValue() Accessor for the key value.
java.lang.String	getPcClass() Accessor for the PersistenceCapable class name.
int	hashCode() Accessor for the hashcode
java.lang.String	toString() Creates a String representation of the datastore identity, formed from the PC class name and the key value.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final transient Localiser LOCALISER

Localiser for messages.

oid

public final java.lang.Object oid

The key value.

pcClass

public final java.lang.String pcClass

The PersistenceCapable class name

toString

public final java.lang.String toString

pre-created toString to improve performance

hashCode

public final int hashCode

pre-created hasCode to improve performance

Constructor Detail

OIDImpl

public OIDImpl()

Creates an OID with no value. Required by the JDO spec

OIDImpl

public OIDImpl(java.lang.String pcClass,
               java.lang.Object object)

Create a string datastore identity.

Parameters:

pcClass - The PersistenceCapable class that this represents

object - The value

OIDImpl

public OIDImpl(java.lang.String str)
        throws java.lang.IllegalArgumentException

Constructs an OID from its string representation that is consistent with the output of toString().

Parameters:

str - the string representation of an OID

Throws:

java.lang.IllegalArgumentException - if the given string representation is not valid.

See Also:

toString

Method Detail

getKeyValue

public java.lang.Object getKeyValue()

Accessor for the key value.

Specified by:

getKeyValue in interface OID

Returns:

The key value

getPcClass

public java.lang.String getPcClass()

Accessor for the PersistenceCapable class name.

Specified by:

getPcClass in interface OID

Returns:

PC class name

equals

public boolean equals(java.lang.Object obj)

Equality operator.

Specified by:

equals in interface OID

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to compare against

Returns:

Whether they are equal

compareTo

public int compareTo(java.lang.Object o)

Comparator method.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - The object to compare against

Returns:

The comparison result

hashCode

public int hashCode()

Accessor for the hashcode

Specified by:

hashCode in interface OID

Overrides:

hashCode in class java.lang.Object

Returns:

Hashcode for this object

toString

public java.lang.String toString()

Creates a String representation of the datastore identity, formed from the PC class name and the key value. This will be something like

3254[OID]mydomain.MyClass

Specified by:

toString in interface OID

Overrides:

toString in class java.lang.Object

Returns:

The String form of the identity