javax.jdo.identity

Class StringIdentity

java.lang.Object

javax.jdo.identity.SingleFieldIdentity

javax.jdo.identity.StringIdentity

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Comparable

public class StringIdentity
extends SingleFieldIdentity

This class is for identity with a single String field.

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.jdo.identity.SingleFieldIdentity

hashCode, keyAsObject, msg

Constructor Summary

Constructors

Constructor and Description
StringIdentity() Constructor only for Externalizable.
StringIdentity(java.lang.Class pcClass, java.lang.String key) Constructor with class and key.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Determine the ordering of identity objects.
boolean	equals(java.lang.Object obj) Determine if the other object represents the same object id.
java.lang.String	getKey() Return the key.
void	readExternal(java.io.ObjectInput in) Read this object.
java.lang.String	toString() Return the String form of the key.
void	writeExternal(java.io.ObjectOutput out) Write this object.

Methods inherited from class javax.jdo.identity.SingleFieldIdentity

assertKeyNotNull, compare, createKeyAsObject, getKeyAsObject, getTargetClass, getTargetClassName, hashClassName, hashCode, setKeyAsObject

Methods inherited from class java.lang.Object

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

Constructor Detail

StringIdentity

public StringIdentity(java.lang.Class pcClass,
                      java.lang.String key)

Constructor with class and key.

Parameters:

pcClass - the class

key - the key

StringIdentity

public StringIdentity()

Constructor only for Externalizable.

Method Detail

getKey

public java.lang.String getKey()

Return the key.

Returns:

the key

toString

public java.lang.String toString()

Return the String form of the key.

Overrides:

toString in class java.lang.Object

Returns:

the String form of the key

equals

public boolean equals(java.lang.Object obj)

Determine if the other object represents the same object id.

Overrides:

equals in class SingleFieldIdentity

Parameters:

obj - the other object

Returns:

true if both objects represent the same object id

compareTo

public int compareTo(java.lang.Object o)

Determine the ordering of identity objects.

Parameters:

o - Other identity

Returns:

The relative ordering between the objects

Since:

2.2

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write this object. Write the superclass first.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class SingleFieldIdentity

Parameters:

out - the output

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Read this object. Read the superclass first.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class SingleFieldIdentity

Parameters:

in - the input

Throws:

java.io.IOException

java.lang.ClassNotFoundException