org.apache.juneau.utils

Class IdMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<K,V>

org.apache.juneau.utils.IdMap<K,V>

Type Parameters:

K - The key type.

V - The value type.

All Implemented Interfaces:

Serializable, ConcurrentMap<K,V>, Map<K,V>

public class IdMap<K,V>
extends ConcurrentHashMap<K,V>

Map consisting of auto-generated atomic keys.

Useful for creating in-memory 'databases' of POJOs.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

ConcurrentHashMap.KeySetView<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
static <K,T> IdMap<K,T>	create(Class<T> c, IdGenerator<K> idGen) Creates a new map.
static <T> IdMap<Integer,T>	createIntMap(Class<T> c) Creates a new ID map with integer keys with generator initialized to 1.
static <T> IdMap<Integer,T>	createIntMap(Class<T> c, int initValue) Creates a new ID map with integer keys with generator initialized to the specified value.
static <T> IdMap<Long,T>	createLongMap(Class<T> c) Creates a new ID map with long keys with generator initialized to 1.
static <T> IdMap<Long,T>	createLongMap(Class<T> c, long initValue) Creates a new ID map with long keys with generator initialized to the specified value.
void	lbId(K k) Sets a lower bound on the specified ID.
K	nextId() Returns the next available ID.

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, get, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.util.AbstractMap

clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createIntMap

public static <T> IdMap<Integer,T> createIntMap(Class<T> c)

Creates a new ID map with integer keys with generator initialized to 1.

Parameters:

c - The value type.

Returns:

A new map.

createIntMap

public static <T> IdMap<Integer,T> createIntMap(Class<T> c,
                                                int initValue)

Creates a new ID map with integer keys with generator initialized to the specified value.

Parameters:

c - The value type.

initValue - The initial value of the generator.

Returns:

A new map.

createLongMap

public static <T> IdMap<Long,T> createLongMap(Class<T> c)

Creates a new ID map with long keys with generator initialized to 1.

Parameters:

c - The value type.

Returns:

A new map.

createLongMap

public static <T> IdMap<Long,T> createLongMap(Class<T> c,
                                              long initValue)

Creates a new ID map with long keys with generator initialized to the specified value.

Parameters:

c - The value type.

initValue - The initial value of the generator.

Returns:

A new map.

create

public static <K,T> IdMap<K,T> create(Class<T> c,
                                      IdGenerator<K> idGen)

Creates a new map.

Parameters:

c - The value type.

idGen - An ID generator.

Returns:

A new instance.

nextId

public K nextId()

Returns the next available ID.

Returns:

The next available ID.

lbId

public void lbId(K k)

Sets a lower bound on the specified ID.

Parameters:

k - The lower-bound key.