it.unimi.dsi.fastutil.bytes
Class Byte2ReferenceMaps

java.lang.Object
  extended by it.unimi.dsi.fastutil.bytes.Byte2ReferenceMaps

public class Byte2ReferenceMaps
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 Byte2ReferenceMaps.EmptyMap<V>
          An immutable class representing an empty type-specific map.
static class Byte2ReferenceMaps.Singleton<V>
          An immutable class representing a type-specific singleton map.
static class Byte2ReferenceMaps.SynchronizedMap<V>
          A synchronized wrapper class for maps.
static class Byte2ReferenceMaps.UnmodifiableMap<V>
          An unmodifiable wrapper class for maps.
 
Field Summary
static Byte2ReferenceMaps.EmptyMap EMPTY_MAP
          An empty type-specific map (immutable).
 
Method Summary
static
<V> Byte2ReferenceMap<V>
singleton(byte key, V value)
          Returns a type-specific immutable map containing only the specified pair.
static
<V> Byte2ReferenceMap<V>
singleton(Byte key, V value)
          Returns a type-specific immutable map containing only the specified pair.
static
<V> Byte2ReferenceMap<V>
synchronize(Byte2ReferenceMap<V> m)
          Returns a synchronized type-specific map backed by the given type-specific map.
static
<V> Byte2ReferenceMap<V>
synchronize(Byte2ReferenceMap<V> m, Object sync)
          Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.
static
<V> Byte2ReferenceMap<V>
unmodifiable(Byte2ReferenceMap<V> 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 Byte2ReferenceMaps.EmptyMap EMPTY_MAP
An empty type-specific map (immutable). It is serializable and cloneable.

Method Detail

singleton

public static <V> Byte2ReferenceMap<V> singleton(byte 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>.

singleton

public static <V> Byte2ReferenceMap<V> singleton(Byte 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 <V> Byte2ReferenceMap<V> synchronize(Byte2ReferenceMap<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 <V> Byte2ReferenceMap<V> synchronize(Byte2ReferenceMap<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 <V> Byte2ReferenceMap<V> unmodifiable(Byte2ReferenceMap<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)