Package com.coyotegulch.jisp
Class StringKey
- java.lang.Object
-
- com.coyotegulch.jisp.KeyObject
-
- com.coyotegulch.jisp.StringKey
-
- All Implemented Interfaces:
java.io.Externalizable
,java.io.Serializable
public class StringKey extends KeyObject
StringKey
defines a 16-character fixed-length text key.- See Also:
KeyObject
,ObjectIndex
, Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(KeyObject key)
Compares the invokingStringKey
tokey
, returning one of theKEY_*
constants based on the relationship of the two keys.int
hashCode()
Returns a hash code value for the object, which is, in effect, the the sum of the characters in the string key value.KeyObject
makeNullKey()
Returns a "null" (i.e., blank)StringKey
, to be used as a space-holder in certain kinds ofObjectIndexes
.void
readExternal(java.io.ObjectInput in)
StringKey
implements the readExternal method to restore its contents.java.lang.String
toString()
Returns theString
representation of aStringKey
.void
writeExternal(java.io.ObjectOutput out)
StringKey
implements thewriteExternal
method to save its contents.
-
-
-
Field Detail
-
KEY_LENGTH
protected static final int KEY_LENGTH
- See Also:
- Constant Field Values
-
-
Method Detail
-
compareTo
public int compareTo(KeyObject key)
Compares the invokingStringKey
tokey
, returning one of theKEY_*
constants based on the relationship of the two keys.
-
makeNullKey
public KeyObject makeNullKey()
Returns a "null" (i.e., blank)StringKey
, to be used as a space-holder in certain kinds ofObjectIndexes
.- Specified by:
makeNullKey
in classKeyObject
- Returns:
- a "null" (i.e., blank)
StringKey
constant. - See Also:
BTreeIndex
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
StringKey
implements thewriteExternal
method to save its contents.- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
StringKey
implements the readExternal method to restore its contents.- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
toString
public java.lang.String toString()
Returns theString
representation of aStringKey
.
-
hashCode
public int hashCode()
Returns a hash code value for the object, which is, in effect, the the sum of the characters in the string key value.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hash code value for this object.
- See Also:
Object
,HashIndex
-
-