All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface jdsl.core.api.KeyBasedContainer

public interface KeyBasedContainer

extends Container

KeyBasedContainers may be viewed abstractly as storing pairs of the type, p(k,e) where

• k is the key
• e is the element mapped to k

insert(Locator)

Inserts a Locator into this Container.

insert(Object, Object)

Inserts a <key, element> pair into this Container.

keys()

Returns an enumeration of all of the keys of all the locators in the Container.

locators()

Returns an Enumeration of all the Locators within this Container.

makeLocator(Object, Object)

For when you need a locator that can be inserted into this KeyBasedContainer but don't want to insert it quite yet.

remove(Locator)

Removes an element from this Container.

replaceElement(Locator, Object)

Takes constant time -- even in key-based containers, since the element can be changed independently of the key.

replaceKey(Locator, Object)

Changes the mapping of a Locator's element to a new key.

 public abstract void insert(Locator locator) throws InvalidKeyException, InvalidLocatorException, ContainedLocatorException

Inserts a Locator into this Container.

Parameters:

locator - The Locator whose key and element are inserted into this Container.

Throws: InvalidKeyException

If the key referenced by locator is not a type accepted by this Container. (For instance, if the container's Comparator can't compare the element, or if the container should have a comparator but doesn't.)

Throws: InvalidLocatorException

If locator cannot be inserted into this container.

 public abstract Locator insert(Object key,
                                Object element) throws InvalidKeyException

Inserts a <key, element> pair into this Container. Here, key is an explicit key. That is, it is mapped to element and used to position element within this Container.

Parameters:

key - The key used to position the element within this Container.

element - The element to be inserted into this Container.

Returns:

A Locator which points to element within this Container.

Throws: InvalidKeyException

If key is not a type accepted by this Container. (For instance, if the container's Comparator can't compare the element, or if the container should have a comparator but doesn't.)

 public abstract void remove(Locator locator) throws InvalidLocatorException, UncontainedLocatorException

Removes an element from this Container. This method provides the only guaranteed way of removing a particular element from a KeyBasedContainer. The Container may make no guarantee about the uniqueness of its keys or stored elements. Many elements may be mapped to the same key and vice versa depending upon the particular implementaion.

Parameters:

locator - The Locator which points to a particular element within this Container.

Throws: InvalidLocatorException

If locator is invalid.

Throws: UncontainedLocatorException

If locator is not in a container.

 public abstract Object replaceKey(Locator locator,
                                   Object key) throws InvalidLocatorException, InvalidKeyException

Changes the mapping of a Locator's element to a new key. That is, within this Container locator's element will now be mapped to key. The original key this element was mapped to is returned Note: this method does not necessarily remove the old key (other elements within this Container may be mapped to it).

Parameters:

locator - The Locator which points to a particular element within this Container.

key - The new key to which locator's element should be mapped.

Returns:

The old key to which locator's element was mapped.

Throws: InvalidLocatorException

If locator is invalid (For example: It does not actually reference an element in this Container).

Throws: InvalidKeyException

If key is not a type accepted by this Container (e.g. If this Container is unable to use key as a key).

 public abstract Object replaceElement(Locator loc,
                                       Object newElement) throws InvalidLocatorException

Takes constant time -- even in key-based containers, since the element can be changed independently of the key.

Parameters:

loc - Locator at which replacement should occur

newElement - Element now to be stored at Locator loc

Returns:

Old element, previously stored at Locator loc

 public abstract Enumeration locators()

Returns an Enumeration of all the Locators within this Container. If this Container is empty then an empty Enumeration is returned.

Returns:

An Enumeration of all the Locators stored in the container. Note: this Enumeration may be empty.

 public abstract Enumeration keys()

Returns an enumeration of all of the keys of all the locators in the Container.

Returns:

An Enumeration of all the keys in this container. Note: this Enumeration may be empty.

 public abstract Locator makeLocator(Object key,
                                     Object element) throws InvalidKeyException

For when you need a locator that can be inserted into this KeyBasedContainer but don't want to insert it quite yet.

All Packages  Class Hierarchy  This Package  Previous  Next  Index