org.fujion.common

Class RegistryMap<KEY,VALUE>

java.lang.Object

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

Type Parameters:

KEY - The class of the indexing key.

VALUE - The class of the stored item.

All Implemented Interfaces:

Map<KEY,VALUE>

public class RegistryMap<KEY,VALUE>
extends Object
implements Map<KEY,VALUE>

Wraps a map, providing the ability to control whether key values may be replaced.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryMap.DuplicateAction

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RegistryMap() Defaults to concurrent hash map and replaceable keys.
RegistryMap(Map<KEY,VALUE> map) Wraps the specified map, allowing replaceable keys.
RegistryMap(Map<KEY,VALUE> map, RegistryMap.DuplicateAction duplicateAction)
RegistryMap(RegistryMap.DuplicateAction duplicateAction) Uses concurrent hash map.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<KEY,VALUE>>	entrySet()
VALUE	get(Object key)
boolean	isEmpty()
Set<KEY>	keySet()
VALUE	put(KEY key, VALUE value)
void	putAll(Map<? extends KEY,? extends VALUE> m)
VALUE	remove(Object key)
int	size()
Collection<VALUE>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RegistryMap

public RegistryMap()

Defaults to concurrent hash map and replaceable keys.

RegistryMap

public RegistryMap(Map<KEY,VALUE> map)

Wraps the specified map, allowing replaceable keys.

Parameters:

map - Map to be wrapped. If null, a concurrent hash map is created and used.

RegistryMap

public RegistryMap(RegistryMap.DuplicateAction duplicateAction)

Uses concurrent hash map.

Parameters:

duplicateAction - Behavior on attempt to replace existing key.

RegistryMap

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

Parameters:

map - Map to be wrapped. If null, a concurrent hash map is created and used.

duplicateAction - Behavior on attempt to replace existing key.

Method Detail

size

public int size()

Specified by:

size in interface Map<KEY,VALUE>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<KEY,VALUE>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<KEY,VALUE>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<KEY,VALUE>

get

public VALUE get(Object key)

Specified by:

get in interface Map<KEY,VALUE>

put

public VALUE put(KEY key,
                 VALUE value)

Specified by:

put in interface Map<KEY,VALUE>

remove

public VALUE remove(Object key)

Specified by:

remove in interface Map<KEY,VALUE>

putAll

public void putAll(Map<? extends KEY,? extends VALUE> m)

Specified by:

putAll in interface Map<KEY,VALUE>

clear

public void clear()

Specified by:

clear in interface Map<KEY,VALUE>

keySet

public Set<KEY> keySet()

Specified by:

keySet in interface Map<KEY,VALUE>

values

public Collection<VALUE> values()

Specified by:

values in interface Map<KEY,VALUE>

entrySet

public Set<Map.Entry<KEY,VALUE>> entrySet()

Specified by:

entrySet in interface Map<KEY,VALUE>