org.apache.excalibur.store.impl

Class JispKey

java.lang.Object

com.coyotegulch.jisp.KeyObject

org.apache.excalibur.store.impl.JispKey

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public final class JispKey
extends com.coyotegulch.jisp.KeyObject

Wrapper class for Keys to be compatible with the Jisp KeyObject.

Version:

CVS $Id: JispKey.java,v 1.4 2004/02/28 11:47:31 cziegeler Exp $

Author:

Avalon Development Team

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	m_Key
protected static JispKey	NULL_KEY
(package private) static long	serialVersionUID

Fields inherited from class com.coyotegulch.jisp.KeyObject

KEY_EQUAL, KEY_ERROR, KEY_LESS, KEY_MORE

Constructor Summary

Constructors

Constructor and Description
JispKey()
JispKey(java.lang.Object keyValue) Constructor for the JispKey object

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(com.coyotegulch.jisp.KeyObject key) Compares two Keys
java.lang.Object	getKey() Return the real key
com.coyotegulch.jisp.KeyObject	makeNullKey() Composes a null Kewy
void	readExternal(java.io.ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	writeExternal(java.io.ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class com.coyotegulch.jisp.KeyObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

m_Key

protected java.lang.Object m_Key

NULL_KEY

protected static JispKey NULL_KEY

Constructor Detail

JispKey

public JispKey()

JispKey

public JispKey(java.lang.Object keyValue)

Constructor for the JispKey object

Parameters:

keyValue - the key

Method Detail

compareTo

public int compareTo(com.coyotegulch.jisp.KeyObject key)

Compares two Keys

Specified by:

compareTo in class com.coyotegulch.jisp.KeyObject

Parameters:

key - the KeyObject to be compared

Returns:

0 if equal, 1 if greater, -1 if less

makeNullKey

public com.coyotegulch.jisp.KeyObject makeNullKey()

Composes a null Kewy

Specified by:

makeNullKey in class com.coyotegulch.jisp.KeyObject

Returns:

a null Key

writeExternal

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

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException

readExternal

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

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getKey

public java.lang.Object getKey()

Return the real key