javax.jdo.identity
Class CharIdentity

java.lang.Object
  extended by javax.jdo.identity.SingleFieldIdentity
      extended by javax.jdo.identity.CharIdentity
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class CharIdentity
extends SingleFieldIdentity

This class is for identity with a single character field.

Version:
2.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.jdo.identity.SingleFieldIdentity
hashCode, keyAsObject
 
Constructor Summary
CharIdentity()
          Constructor only for Externalizable.
CharIdentity(java.lang.Class pcClass, char key)
          Constructor with class and key.
CharIdentity(java.lang.Class pcClass, java.lang.Character key)
          Constructor with class and key.
CharIdentity(java.lang.Class pcClass, java.lang.String str)
          Constructor with class and key.
 
Method Summary
protected  java.lang.Object createKeyAsObject()
          Create the key as an Object.
 boolean equals(java.lang.Object obj)
          Determine if the other object represents the same object id.
 char 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, getKeyAsObject, getTargetClass, getTargetClassName, hashClassName, hashCode, setKeyAsObject
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CharIdentity

public CharIdentity(java.lang.Class pcClass,
                    char key)
Constructor with class and key.

Parameters:
pcClass - the target class
key - the key

CharIdentity

public CharIdentity(java.lang.Class pcClass,
                    java.lang.Character key)
Constructor with class and key.

Parameters:
pcClass - the target class
key - the key

CharIdentity

public CharIdentity(java.lang.Class pcClass,
                    java.lang.String str)
Constructor with class and key. The String must have exactly one character.

Parameters:
pcClass - the target class
str - the key

CharIdentity

public CharIdentity()
Constructor only for Externalizable.

Method Detail

getKey

public char 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

createKeyAsObject

protected java.lang.Object createKeyAsObject()
Create the key as an Object.

Overrides:
createKeyAsObject in class SingleFieldIdentity
Returns:
the key as an Object
Since:
2.0

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


Copyright © 2005-2006 Apache Software Foundation. All Rights Reserved.