it.unimi.dsi.fastutil.objects
Class Reference2BooleanFunctions.UnmodifiableFunction<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction<K>
      it.unimi.dsi.fastutil.objects.Reference2BooleanFunctions.UnmodifiableFunction<K>

All Implemented Interfaces:

Function<K,Boolean>, Reference2BooleanFunction<K>, Serializable

Direct Known Subclasses:

Reference2BooleanMaps.UnmodifiableMap

Enclosing class:

Reference2BooleanFunctions

public static class Reference2BooleanFunctions.UnmodifiableFunction<K>
extends AbstractReference2BooleanFunction<K>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(Object k) Returns true if this function contains a mapping for the specified key.
boolean	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(boolean defRetValue) Sets the default return value.
boolean	getBoolean(Object k) Returns the value to which the given key is mapped.
boolean	put(K k, boolean v) Adds a pair to the map.
boolean	removeBoolean(Object k) Removes the mapping with the given key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
String	toString()

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction

get, put, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

size

public int size()

Description copied from interface: Function

Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:

size in interface Function<K,Boolean>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(Object k)

Description copied from interface: Function

Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:

containsKey in interface Function<K,Boolean>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

defaultReturnValue

public boolean defaultReturnValue()

Description copied from interface: Reference2BooleanFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Reference2BooleanFunction<K>

Overrides:

defaultReturnValue in class AbstractReference2BooleanFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(boolean defRetValue)

Description copied from interface: Reference2BooleanFunction

Sets the default return value. This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.

Specified by:

defaultReturnValue in interface Reference2BooleanFunction<K>

Overrides:

defaultReturnValue in class AbstractReference2BooleanFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Reference2BooleanFunction.defaultReturnValue()

put

public boolean put(K k,
                   boolean v)

Description copied from interface: Reference2BooleanFunction

Adds a pair to the map.

Specified by:

put in interface Reference2BooleanFunction<K>

Overrides:

put in class AbstractReference2BooleanFunction<K>

Parameters:

k - the key.

v - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.put(Object,Object)

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<K,Boolean>

Overrides:

clear in class AbstractReference2BooleanFunction<K>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object

removeBoolean

public boolean removeBoolean(Object k)

Description copied from interface: Reference2BooleanFunction

Removes the mapping with the given key.

Specified by:

removeBoolean in interface Reference2BooleanFunction<K>

Overrides:

removeBoolean in class AbstractReference2BooleanFunction<K>

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.remove(Object)

getBoolean

public boolean getBoolean(Object k)

Description copied from interface: Reference2BooleanFunction

Returns the value to which the given key is mapped.

Specified by:

getBoolean in interface Reference2BooleanFunction<K>

Parameters:

k - the key.

Returns:

the corresponding value, or the default return value if no value was present for the given key.

See Also:

Function.get(Object)