it.unimi.dsi.fastutil.objects
Class Reference2CharMaps

java.lang.Object
  it.unimi.dsi.fastutil.objects.Reference2CharMaps

public class Reference2CharMaps
extends Object

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

See Also:

Maps, Collections

Nested Class Summary

static class	Reference2CharMaps.EmptyMap<K> An immutable class representing an empty type-specific map.
static class	Reference2CharMaps.Singleton<K> An immutable class representing a type-specific singleton map.
static class	Reference2CharMaps.SynchronizedMap<K> A synchronized wrapper class for maps.
static class	Reference2CharMaps.UnmodifiableMap<K> An unmodifiable wrapper class for maps.

Field Summary

static Reference2CharMaps.EmptyMap

EMPTY_MAP An empty type-specific map (immutable).

Method Summary

static <K> Reference2CharMap<K>	singleton(K key, char value) Returns a type-specific immutable map containing only the specified pair.
static <K> Reference2CharMap<K>	singleton(K key, Character value) Returns a type-specific immutable map containing only the specified pair.
static <K> Reference2CharMap<K>	synchronize(Reference2CharMap<K> m) Returns a synchronized type-specific map backed by the given type-specific map.
static <K> Reference2CharMap<K>	synchronize(Reference2CharMap<K> m, Object sync) Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.
static <K> Reference2CharMap<K>	unmodifiable(Reference2CharMap<K> m) Returns an unmodifiable type-specific map backed by the given type-specific map.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MAP

public static final Reference2CharMaps.EmptyMap EMPTY_MAP

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

Method Detail

singleton

public static <K> Reference2CharMap<K> singleton(K key,
                                                 char 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>.

singleton

public static <K> Reference2CharMap<K> singleton(K key,
                                                 Character 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> Reference2CharMap<K> synchronize(Reference2CharMap<K> 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> Reference2CharMap<K> synchronize(Reference2CharMap<K> 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> Reference2CharMap<K> unmodifiable(Reference2CharMap<K> 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)