com.cafesoft.core.util
Interface NamespaceMap

All Superinterfaces:

Recyclable, Serializable

All Known Implementing Classes:

NamespaceHashMap

public interface NamespaceMap

extends Recyclable, Serializable

A data structure for storing namespaces and their associated name/value pairs.

Since:

5/14/02

Field Summary

static String

DEFAULT_NAMESPACE The default namespace that all name/value pairs are inserted.

Method Summary

Object	get(String namespace, String name) Get a value from the NamespaceMap
String[]	getNames(String namespace) Get the names of all the values in the NamespaceMap
String[]	getNamespaces() Get all value namespaces.
void	put(String namespace, String name, Object value) Put an value into NamespaceMap Put an object into the NamespaceMap via a name string and namespace.
void	remove(String namespace, String name) Remove a value from the NamespaceMap
int	size() Returns the number of key-value mappings in this map.

Methods inherited from interface com.cafesoft.core.util.Recyclable

recycle

Field Detail

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

The default namespace that all name/value pairs are inserted.

See Also:

Constant Field Values

Method Detail

put

public void put(String namespace,
                String name,
                Object value)

Put an value into NamespaceMap

Put an object into the NamespaceMap via a name string and namespace.

Parameters:

namespace - a namespace used to distinguish a name (perhaps used by a particular application), from an identical name used in another context. If null, then use the "default" namespace.

name - the name of the value

value - The value to insert into the NamespaceMap

Throws:

IllegalArgumentException - thrown if the name is null

remove

public void remove(String namespace,
                   String name)

Remove a value from the NamespaceMap

Parameters:

namespace - the namespace of the name/value pair

name - the name string of the value to remove

Throws:

IllegalArgumentException - thrown if the name is null

get

public Object get(String namespace,
                  String name)

Get a value from the NamespaceMap

Parameters:

namespace - the namespace of the name/value pair

name - the name string to get the value for

Returns:

The value from the NamespaceMap, null if the name doesn't exist.

Throws:

IllegalArgumentException - thrown if the name is null

getNamespaces

public String[] getNamespaces()

Get all value namespaces.

Returns:

a String array of all namespaces used for values currently stored in the NamespaceMap including the "default" namepace.

getNames

public String[] getNames(String namespace)

Get the names of all the values in the NamespaceMap

Parameters:

namespace - the namespace of values to be retrieved. If null the default namespace is used.

Returns:

A String array of all names in the NamespaceMap that contain values

size

public int size()

Returns the number of key-value mappings in this map.

Returns:

the number of key-value mappings in this map