it.unimi.dsi.fastutil.objects
Class Reference2BooleanFunctions

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.Reference2BooleanFunctions

public class Reference2BooleanFunctions
extends 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 Reference2BooleanFunctions.EmptyFunction<K>
          An immutable class representing an empty type-specific function.
static class Reference2BooleanFunctions.Singleton<K>
          An immutable class representing a type-specific singleton function.
static class Reference2BooleanFunctions.SynchronizedFunction<K>
          A synchronized wrapper class for functions.
static class Reference2BooleanFunctions.UnmodifiableFunction<K>
          An unmodifiable wrapper class for functions.
 
Field Summary
static Reference2BooleanFunctions.EmptyFunction EMPTY_FUNCTION
          An empty type-specific function (immutable).
 
Method Summary
static
<K> Reference2BooleanFunction<K>
singleton(K key, boolean value)
          Returns a type-specific immutable function containing only the specified pair.
static
<K> Reference2BooleanFunction<K>
singleton(K key, Boolean value)
          Returns a type-specific immutable function containing only the specified pair.
static
<K> Reference2BooleanFunction<K>
synchronize(Reference2BooleanFunction<K> f)
          Returns a synchronized type-specific function backed by the given type-specific function.
static
<K> Reference2BooleanFunction<K>
synchronize(Reference2BooleanFunction<K> f, Object sync)
          Returns a synchronized type-specific function backed by the given type-specific function, using an assigned object to synchronize.
static
<K> Reference2BooleanFunction<K>
unmodifiable(Reference2BooleanFunction<K> 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 Reference2BooleanFunctions.EmptyFunction EMPTY_FUNCTION
An empty type-specific function (immutable). It is serializable and cloneable.

Method Detail

singleton

public static <K> Reference2BooleanFunction<K> singleton(K key,
                                                         boolean 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 <K> Reference2BooleanFunction<K> singleton(K key,
                                                         Boolean 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 <K> Reference2BooleanFunction<K> synchronize(Reference2BooleanFunction<K> 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 <K> Reference2BooleanFunction<K> synchronize(Reference2BooleanFunction<K> f,
                                                           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 <K> Reference2BooleanFunction<K> unmodifiable(Reference2BooleanFunction<K> 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)