it.unimi.dsi.fastutil.chars
Class Char2ReferenceFunctions

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.Char2ReferenceFunctions

public class Char2ReferenceFunctions
extends java.lang.Object

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

See Also:
Function, Collections

Nested Class Summary
static class Char2ReferenceFunctions.EmptyFunction<V>
          An immutable class representing an empty type-specific function.
static class Char2ReferenceFunctions.Singleton<V>
          An immutable class representing a type-specific singleton function.
static class Char2ReferenceFunctions.SynchronizedFunction<V>
          A synchronized wrapper class for functions.
static class Char2ReferenceFunctions.UnmodifiableFunction<V>
          An unmodifiable wrapper class for functions.
 
Field Summary
static Char2ReferenceFunctions.EmptyFunction EMPTY_FUNCTION
          An empty type-specific function (immutable).
 
Method Summary
static
<V> Char2ReferenceFunction<V>
singleton(java.lang.Character key, V value)
          Returns a type-specific immutable function containing only the specified pair.
static
<V> Char2ReferenceFunction<V>
singleton(char key, V value)
          Returns a type-specific immutable function containing only the specified pair.
static
<V> Char2ReferenceFunction<V>
synchronize(Char2ReferenceFunction<V> f)
          Returns a synchronized type-specific function backed by the given type-specific function.
static
<V> Char2ReferenceFunction<V>
synchronize(Char2ReferenceFunction<V> f, java.lang.Object sync)
          Returns a synchronized type-specific function backed by the given type-specific function, using an assigned object to synchronize.
static
<V> Char2ReferenceFunction<V>
unmodifiable(Char2ReferenceFunction<V> f)
          Returns an unmodifiable type-specific function backed by the given type-specific function.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_FUNCTION

public static final Char2ReferenceFunctions.EmptyFunction EMPTY_FUNCTION
An empty type-specific function (immutable). It is serializable and cloneable.

Method Detail

singleton

public static <V> Char2ReferenceFunction<V> singleton(char key,
                                                      V value)
Returns a type-specific immutable function containing only the specified pair. The returned function is serializable and cloneable.

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

Parameters:
key - the only key of the returned function.
value - the only value of the returned function.
Returns:
a type-specific immutable function containing just the pair <key,value>.

singleton

public static <V> Char2ReferenceFunction<V> singleton(java.lang.Character key,
                                                      V value)
Returns a type-specific immutable function containing only the specified pair. The returned function is serializable and cloneable.

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

Parameters:
key - the only key of the returned function.
value - the only value of the returned function.
Returns:
a type-specific immutable function containing just the pair <key,value>.

synchronize

public static <V> Char2ReferenceFunction<V> synchronize(Char2ReferenceFunction<V> f)
Returns a synchronized type-specific function backed by the given type-specific function.

Parameters:
f - the function to be wrapped in a synchronized function.
Returns:
a synchronized view of the specified function.
See Also:
Collections.synchronizedMap(java.util.Map)

synchronize

public static <V> Char2ReferenceFunction<V> synchronize(Char2ReferenceFunction<V> f,
                                                        java.lang.Object sync)
Returns a synchronized type-specific function backed by the given type-specific function, using an assigned object to synchronize.

Parameters:
f - the function to be wrapped in a synchronized function.
sync - an object that will be used to synchronize the access to the function.
Returns:
a synchronized view of the specified function.
See Also:
Collections.synchronizedMap(java.util.Map)

unmodifiable

public static <V> Char2ReferenceFunction<V> unmodifiable(Char2ReferenceFunction<V> f)
Returns an unmodifiable type-specific function backed by the given type-specific function.

Parameters:
f - the function to be wrapped in an unmodifiable function.
Returns:
an unmodifiable view of the specified function.
See Also:
Collections.unmodifiableMap(java.util.Map)