it.unimi.dsi.fastutil.objects

Class Reference2ReferenceMaps

java.lang.Object

it.unimi.dsi.fastutil.objects.Reference2ReferenceMaps

public class Reference2ReferenceMaps
extends Object

A class providing static methods and objects that do useful things with type-specific maps.

See Also:

Maps, Collections

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reference2ReferenceMaps.EmptyMap<K,V> An immutable class representing an empty type-specific map.
static class	Reference2ReferenceMaps.Singleton<K,V> An immutable class representing a type-specific singleton map.
static class	Reference2ReferenceMaps.SynchronizedMap<K,V> A synchronized wrapper class for maps.
static class	Reference2ReferenceMaps.UnmodifiableMap<K,V> An unmodifiable wrapper class for maps.

Field Summary

Fields

Modifier and Type	Field and Description
static Reference2ReferenceMaps.EmptyMap	EMPTY_MAP An empty type-specific map (immutable).

Method Summary

Methods

Modifier and Type	Method and Description
static <K,V> Reference2ReferenceMap<K,V>	singleton(K key, V value) Returns a type-specific immutable map containing only the specified pair.
static <K,V> Reference2ReferenceMap<K,V>	synchronize(Reference2ReferenceMap<K,V> m) Returns a synchronized type-specific map backed by the given type-specific map.
static <K,V> Reference2ReferenceMap<K,V>	synchronize(Reference2ReferenceMap<K,V> m, Object sync) Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.
static <K,V> Reference2ReferenceMap<K,V>	unmodifiable(Reference2ReferenceMap<K,V> m) Returns an unmodifiable type-specific map backed by the given type-specific map.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MAP

public static final Reference2ReferenceMaps.EmptyMap EMPTY_MAP

An empty type-specific map (immutable). It is serializable and cloneable.

Method Detail

singleton

public static <K,V> Reference2ReferenceMap<K,V> singleton(K key,
                                          V value)

Returns a type-specific immutable map containing only the specified pair. The returned map is serializable and cloneable.

Note that albeit the returned map is immutable, its default return value may be changed.

Parameters:

key - the only key of the returned map.

value - the only value of the returned map.

Returns:

a type-specific immutable map containing just the pair <key,value>.

synchronize

public static <K,V> Reference2ReferenceMap<K,V> synchronize(Reference2ReferenceMap<K,V> m)

Returns a synchronized type-specific map backed by the given type-specific map.

Parameters:

m - the map to be wrapped in a synchronized map.

Returns:

a synchronized view of the specified map.

See Also:

Collections.synchronizedMap(Map)

synchronize

public static <K,V> Reference2ReferenceMap<K,V> synchronize(Reference2ReferenceMap<K,V> m,
                                            Object sync)

Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.

Parameters:

m - the map to be wrapped in a synchronized map.

sync - an object that will be used to synchronize the access to the map.

Returns:

a synchronized view of the specified map.

See Also:

Collections.synchronizedMap(Map)

unmodifiable

public static <K,V> Reference2ReferenceMap<K,V> unmodifiable(Reference2ReferenceMap<K,V> m)

Returns an unmodifiable type-specific map backed by the given type-specific map.

Parameters:

m - the map to be wrapped in an unmodifiable map.

Returns:

an unmodifiable view of the specified map.

See Also:

Collections.unmodifiableMap(Map)