net.sf.octet.collection
Interface AtomMap

All Known Implementing Classes:

BasicAtomMap

public interface AtomMap

Enables the many-to-one association of Atoms. AtomMap provides a non-index based method for redirecting Atom requests. Like all other interfaces in the net.sf.octet.collection package, AtomMap is immutable, meaning that all method invocations return the same result over the lifetime of implementing objects.

Author:

Richard Apodaca

Method Summary

boolean	containsKey(Atom key) Returns true if key is contained among the keys in this AtomMap or false otherwise.
boolean	containsValue(Atom value) Returns true if value is contained among the values in this AtomMap.
int	countAtomEntries() Returns the number of associations.
Atom	getAtom(Atom key) Returns the Atom associated with key.
AtomIterator	iterateAtomKeys() Returns an AtomIterator over all keys.
AtomIterator	iterateAtomValues() Returns an AtomIterator over all values.

Method Detail

getAtom

public Atom getAtom(Atom key)

Returns the Atom associated with key.

Parameters:

key - the Atom key

Returns:

the Atom associated with key

Throws:

NoSuchAtomException - if key is not found

countAtomEntries

public int countAtomEntries()

Returns the number of associations.

Returns:

the number of associations.

containsKey

public boolean containsKey(Atom key)

Returns true if key is contained among the keys in this AtomMap or false otherwise.

Parameters:

key - the Atom key

Returns:

true if found, or false otherwise

containsValue

public boolean containsValue(Atom value)

Returns true if value is contained among the values in this AtomMap.

Parameters:

value - the Atom value

Returns:

true if found, or false otherwise

iterateAtomKeys

public AtomIterator iterateAtomKeys()

Returns an AtomIterator over all keys.

Returns:

an AtomIterator over all keys

iterateAtomValues

public AtomIterator iterateAtomValues()

Returns an AtomIterator over all values.

Returns:

an AtomIterator over all values