com.coyotegulch.jisp
Class DuplicateKeyException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.io.IOException
              extended bycom.coyotegulch.jisp.DatabaseException
                  extended bycom.coyotegulch.jisp.DuplicateKeyException
All Implemented Interfaces:
java.io.Serializable

public class DuplicateKeyException
extends DatabaseException

A ObjectIndex throws a DuplicateKeyException when a key being added to the index is identical to a key already stored there. Each concrete index class determines the circumstances under which this exception is thrown. For example, a BTreeIndex will throw DuplicateKeyException when a call to the insertKey method finds an existing key that matches the insertion key; however, the BTreeIndex.writeKey method does not throw an exception for a duplicate key, instead replacing the record position associated with the extant key.

See Also:
ObjectIndex, BTreeIndex, Serialized Form

Constructor Summary
DuplicateKeyException()
          Constructs a new DuplicateKeyException with null as its error message string.
DuplicateKeyException(OrderedObject key)
          Constructs a new DuplicateKeyException with message as its error message string.
 
Method Summary
 OrderedObject getKey()
          Returns the key object that was not found.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DuplicateKeyException

public DuplicateKeyException()
Constructs a new DuplicateKeyException with null as its error message string.


DuplicateKeyException

public DuplicateKeyException(OrderedObject key)
Constructs a new DuplicateKeyException with message as its error message string.

Parameters:
key - the key that could not be found
Method Detail

getKey

public OrderedObject getKey()
Returns the key object that was not found.

Returns:
the key object that could not be found