it.unimi.dsi.fastutil.bytes
Class Byte2ObjectSortedMaps

java.lang.Object
  extended byit.unimi.dsi.fastutil.bytes.Byte2ObjectSortedMaps

public class Byte2ObjectSortedMaps
extends Object

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

See Also:
Collections

Nested Class Summary
static class Byte2ObjectSortedMaps.EmptySortedMap
          An immutable class representing an empty type-specific sorted map.
static class Byte2ObjectSortedMaps.Singleton
          An immutable class representing a type-specific singleton sorted map.
static class Byte2ObjectSortedMaps.SynchronizedSortedMap
          A synchronized wrapper class for sorted maps.
static class Byte2ObjectSortedMaps.UnmodifiableSortedMap
          An unmodifiable wrapper class for sorted maps.
 
Field Summary
static Byte2ObjectSortedMaps.EmptySortedMap EMPTY_MAP
          An empty type-specific sorted map (immutable).
 
Method Summary
static Byte2ObjectSortedMap singleton(byte key, Object value)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Byte2ObjectSortedMap singleton(byte key, Object value, ByteComparator comparator)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Byte2ObjectSortedMap singleton(Object key, Object value)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Byte2ObjectSortedMap singleton(Object key, Object value, ByteComparator comparator)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Byte2ObjectSortedMap synchronize(Byte2ObjectSortedMap m)
          Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
static Byte2ObjectSortedMap synchronize(Byte2ObjectSortedMap m, Object sync)
          Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.
static Byte2ObjectSortedMap unmodifiable(Byte2ObjectSortedMap m)
          Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_MAP

public static final Byte2ObjectSortedMaps.EmptySortedMap EMPTY_MAP
An empty type-specific sorted map (immutable). It is serializable and cloneable.

Method Detail

singleton

public static Byte2ObjectSortedMap singleton(byte key,
                                             Object value)
Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.
value - the only value of the returned sorted map.
Returns:
a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Byte2ObjectSortedMap singleton(byte key,
                                             Object value,
                                             ByteComparator comparator)
Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.
value - the only value of the returned sorted map.
comparator - the comparator to use in the returned sorted map.
Returns:
a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Byte2ObjectSortedMap singleton(Object key,
                                             Object value)
Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.
value - the only value of the returned sorted map.
Returns:
a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Byte2ObjectSortedMap singleton(Object key,
                                             Object value,
                                             ByteComparator comparator)
Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted 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 sorted map.
value - the only value of the returned sorted map.
comparator - the comparator to use in the returned sorted map.
Returns:
a type-specific immutable sorted map containing just the pair <key,value>.

synchronize

public static Byte2ObjectSortedMap synchronize(Byte2ObjectSortedMap m)
Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.

Parameters:
m - the sorted map to be wrapped in a synchronized sorted map.
Returns:
a synchronized view of the specified sorted map.
See Also:
Collections.synchronizedSortedMap(SortedMap)

synchronize

public static Byte2ObjectSortedMap synchronize(Byte2ObjectSortedMap m,
                                               Object sync)
Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.

Parameters:
m - the sorted map to be wrapped in a synchronized sorted map.
sync - an object that will be used to synchronize the access to the sorted sorted map.
Returns:
a synchronized view of the specified sorted map.
See Also:
Collections.synchronizedSortedMap(SortedMap)

unmodifiable

public static Byte2ObjectSortedMap unmodifiable(Byte2ObjectSortedMap m)
Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.

Parameters:
m - the sorted map to be wrapped in an unmodifiable sorted map.
Returns:
an unmodifiable view of the specified sorted map.
See Also:
Collections.unmodifiableSortedMap(SortedMap)