it.unimi.dsi.fastutil.objects

Class AbstractObject2BooleanFunction<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction<K>

All Implemented Interfaces:

Function<K,Boolean>, Object2BooleanFunction<K>, Serializable

Direct Known Subclasses:

AbstractObject2BooleanMap, Object2BooleanFunctions.EmptyFunction, Object2BooleanFunctions.Singleton, Object2BooleanFunctions.SynchronizedFunction, Object2BooleanFunctions.UnmodifiableFunction

public abstract class AbstractObject2BooleanFunction<K>
extends Object
implements Object2BooleanFunction<K>, Serializable

An abstract class providing basic methods for functions implementing a type-specific interface.

Optional operations just throw an UnsupportedOperationException. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules (they take care of returning null on a missing key).

This class handles directly a default return value (including methods to access it). Instances of classes inheriting from this class have just to return defRetValue to denote lack of a key in type-specific methods. The value is serialized.

Implementing subclasses have just to provide type-specific get(), type-specific containsKey(), and size() methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	defRetValue The default return value for get(), put() and remove().
static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractObject2BooleanFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
boolean	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(boolean rv) Sets the default return value.
Boolean	get(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
boolean	put(K key, boolean value) Adds a pair to the map.
Boolean	put(K ok, Boolean ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
Boolean	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
boolean	removeBoolean(Object key) Removes the mapping with the given key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2BooleanFunction

getBoolean

Methods inherited from interface it.unimi.dsi.fastutil.Function

containsKey, size

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

defRetValue

protected boolean defRetValue

The default return value for get(), put() and remove().

Constructor Detail

AbstractObject2BooleanFunction

protected AbstractObject2BooleanFunction()

Method Detail

defaultReturnValue

public void defaultReturnValue(boolean rv)

Description copied from interface: Object2BooleanFunction

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 Object2BooleanFunction<K>

Parameters:

rv - the new default return value.

See Also:

Object2BooleanFunction.defaultReturnValue()

defaultReturnValue

public boolean defaultReturnValue()

Description copied from interface: Object2BooleanFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2BooleanFunction<K>

Returns:

the current default return value.

put

public boolean put(K key,
          boolean value)

Description copied from interface: Object2BooleanFunction

Adds a pair to the map.

Specified by:

put in interface Object2BooleanFunction<K>

Parameters:

key - the key.

value - 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)

removeBoolean

public boolean removeBoolean(Object key)

Description copied from interface: Object2BooleanFunction

Removes the mapping with the given key.

Specified by:

removeBoolean in interface Object2BooleanFunction<K>

Returns:

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

See Also:

Function.remove(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>

See Also:

Map.clear()

get

public Boolean get(Object ok)

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

get in interface Function<K,Boolean>

Parameters:

ok - the key.

Returns:

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

See Also:

Map.get(Object)

put

public Boolean put(K ok,
          Boolean ov)

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

put in interface Function<K,Boolean>

Parameters:

ok - the key.

ov - the value.

Returns:

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

See Also:

Map.put(Object,Object)

remove

public Boolean remove(Object ok)

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

remove in interface Function<K,Boolean>

Returns:

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

See Also:

Map.remove(Object)