it.unimi.dsi.fastutil.floats
Class Float2ShortSortedMaps

java.lang.Object
  extended by it.unimi.dsi.fastutil.floats.Float2ShortSortedMaps

public class Float2ShortSortedMaps
extends java.lang.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 Float2ShortSortedMaps.EmptySortedMap
          An immutable class representing an empty type-specific sorted map.
static class Float2ShortSortedMaps.Singleton
          An immutable class representing a type-specific singleton sorted map.
static class Float2ShortSortedMaps.SynchronizedSortedMap
          A synchronized wrapper class for sorted maps.
static class Float2ShortSortedMaps.UnmodifiableSortedMap
          An unmodifiable wrapper class for sorted maps.
 
Field Summary
static Float2ShortSortedMaps.EmptySortedMap EMPTY_MAP
          An empty type-specific sorted map (immutable).
 
Method Summary
static java.util.Comparator<? super java.util.Map.Entry<java.lang.Float,?>> entryComparator(FloatComparator comparator)
          Returns a comparator for entries based on a given comparator on keys.
static Float2ShortSortedMap singleton(float key, short value)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Float2ShortSortedMap singleton(java.lang.Float key, java.lang.Short value)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Float2ShortSortedMap singleton(float key, short value, FloatComparator comparator)
          Returns a type-specific immutable sorted map containing only the specified pair.
static Float2ShortSortedMap singleton(java.lang.Float key, java.lang.Short value, FloatComparator comparator)
          RETURNS a type-specific immutable sorted map containing only the specified pair.
static Float2ShortSortedMap synchronize(Float2ShortSortedMap m)
          Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
static Float2ShortSortedMap synchronize(Float2ShortSortedMap m, java.lang.Object sync)
          Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.
static Float2ShortSortedMap unmodifiable(Float2ShortSortedMap 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 Float2ShortSortedMaps.EmptySortedMap EMPTY_MAP
An empty type-specific sorted map (immutable). It is serializable and cloneable.

Method Detail

entryComparator

public static java.util.Comparator<? super java.util.Map.Entry<java.lang.Float,?>> entryComparator(FloatComparator comparator)
Returns a comparator for entries based on a given comparator on keys.

Parameters:
comparator - a comparator on keys.
Returns:
the associated comparator on entries.

singleton

public static Float2ShortSortedMap singleton(java.lang.Float key,
                                             java.lang.Short 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 Float2ShortSortedMap singleton(java.lang.Float key,
                                             java.lang.Short value,
                                             FloatComparator 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 Float2ShortSortedMap singleton(float key,
                                             short 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 Float2ShortSortedMap singleton(float key,
                                             short value,
                                             FloatComparator 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 Float2ShortSortedMap synchronize(Float2ShortSortedMap 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 Float2ShortSortedMap synchronize(Float2ShortSortedMap m,
                                               java.lang.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 Float2ShortSortedMap unmodifiable(Float2ShortSortedMap 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)