nz.ac.waikato.jdsl.core.api
Class InspectableDictionary.InvalidLocator

java.lang.Object
  nz.ac.waikato.jdsl.core.api.InspectableDictionary.InvalidLocator

All Implemented Interfaces:

Accessor, Locator

Enclosing interface:

InspectableDictionary

public static final class InspectableDictionary.InvalidLocator
extends java.lang.Object
implements Locator

A locator that is always invalid. Use for all constants such as NO_SUCH_KEY in a failed dictionary search.

Author:

Andrew Schwerin (schwerin)

Constructor Summary

InspectableDictionary.InvalidLocator()

InspectableDictionary.InvalidLocator(java.lang.String msg)

Method Summary

java.lang.Object	element() Gets the element currently associated with this accessor.
java.lang.Object	key()

Methods inherited from class java.lang.Object

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

Constructor Detail

InspectableDictionary.InvalidLocator

public InspectableDictionary.InvalidLocator(java.lang.String msg)

InspectableDictionary.InvalidLocator

public InspectableDictionary.InvalidLocator()

Method Detail

element

public java.lang.Object element()
                         throws InvalidAccessorException

Description copied from interface: Accessor

Gets the element currently associated with this accessor.

Specified by:

element in interface Accessor

Returns:

the element currently stored at this accessor

Throws:

InvalidAccessorException

key

public java.lang.Object key()
                     throws InvalidAccessorException

Specified by:

key in interface Locator

Returns:

the key associated with the locator

Throws:

InvalidAccessorException - if the locator has been removed from its container