public class StringKey extends KeyObject
StringKey
defines a 16-character fixed-length text key.
KeyObject
,
ObjectIndex
,
Serialized FormModifier and Type | Field | Description |
---|---|---|
protected static int |
KEY_LENGTH |
Constructor | Description |
---|---|
StringKey() |
Creates a blank (null)
StringKey . |
StringKey(java.lang.String key_value) |
Creates a new
StringKey using key_value . |
Modifier and Type | Method | Description |
---|---|---|
int |
compareTo(KeyObject key) |
Compares the invoking
StringKey to key , returning one of the
KEY_* 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 of
ObjectIndexes . |
void |
readExternal(java.io.ObjectInput in) |
StringKey implements the readExternal method to restore its contents. |
java.lang.String |
toString() |
Returns the
String representation of a StringKey . |
void |
writeExternal(java.io.ObjectOutput out) |
StringKey implements the writeExternal method to save its
contents. |
protected static final int KEY_LENGTH
public StringKey(java.lang.String key_value)
StringKey
using key_value
.
key_value
- The text of the newly-created key.public StringKey()
StringKey
.public int compareTo(KeyObject key)
StringKey
to key
, returning one of the
KEY_*
constants based on the relationship of the two keys.public KeyObject makeNullKey()
StringKey
, to be used as a space-holder in certain kinds of
ObjectIndexes
.makeNullKey
in class KeyObject
StringKey
constant.BTreeIndex
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
StringKey
implements the writeExternal
method to save its
contents.java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
StringKey
implements the readExternal method to restore its contents.java.io.IOException
java.lang.ClassNotFoundException
public java.lang.String toString()
String
representation of a StringKey
.public int hashCode()
hashCode
in class java.lang.Object
Object
,
HashIndex