org.fujion.common

Class AbstractRegistry<KEY,VALUE>

java.lang.Object

org.fujion.common.AbstractRegistry<KEY,VALUE>

Type Parameters:

KEY - The class of the indexing key.

VALUE - The class of the registered item.

All Implemented Interfaces:

Iterable<VALUE>

public abstract class AbstractRegistry<KEY,VALUE>
extends Object
implements Iterable<VALUE>

Abstract base class for thread-safe registry of shared objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<KEY,VALUE>	map

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegistry()
protected	AbstractRegistry(Map<KEY,VALUE> map, RegistryMap.DuplicateAction duplicateAction)
protected	AbstractRegistry(RegistryMap.DuplicateAction duplicateAction)

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all registry entries.
boolean	contains(KEY key) Returns true if the registry contains the specified item.
VALUE	get(KEY key) Returns the value associated with the specified key.
Collection<VALUE>	getAll() Returns a read-only collection of all registry entries.
protected abstract KEY	getKey(VALUE item) Returns the key to use to store the item.
Iterator<VALUE>	iterator() Iterate over value set.
void	register(VALUE item) Adds an item to the registry.
int	size() Return number of entries.
VALUE	unregister(VALUE item) Removes an item from the registry.
VALUE	unregisterByKey(KEY key) Removes an item from the registry using its key value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

map

protected final Map<KEY,VALUE> map

Constructor Detail

AbstractRegistry

protected AbstractRegistry()

AbstractRegistry

protected AbstractRegistry(RegistryMap.DuplicateAction duplicateAction)

AbstractRegistry

protected AbstractRegistry(Map<KEY,VALUE> map,
                           RegistryMap.DuplicateAction duplicateAction)

Method Detail

getKey

protected abstract KEY getKey(VALUE item)

Returns the key to use to store the item.

Parameters:

item - Item whose key is sought.

Returns:

Key for the item.

get

public VALUE get(KEY key)

Returns the value associated with the specified key.

Parameters:

key - Key whose associated value is sought.

Returns:

Value associated with the key.

contains

public boolean contains(KEY key)

Returns true if the registry contains the specified item.

Parameters:

key - Key of item.

Returns:

True if the item is present.

getAll

public Collection<VALUE> getAll()

Returns a read-only collection of all registry entries.

Returns:

Collection of registry entries.

register

public void register(VALUE item)

Adds an item to the registry.

Parameters:

item - Item to add.

unregister

public VALUE unregister(VALUE item)

Removes an item from the registry.

Parameters:

item - The item to remove.

Returns:

The item that was removed, or null if not found.

unregisterByKey

public VALUE unregisterByKey(KEY key)

Removes an item from the registry using its key value.

Parameters:

key - The key of the item to remove.

Returns:

The item that was removed, or null if not found.

clear

public void clear()

Remove all registry entries.

size

public int size()

Return number of entries.

Returns:

Number of entries.

iterator

public Iterator<VALUE> iterator()

Iterate over value set.

Specified by:

iterator in interface Iterable<VALUE>