it.unimi.dsi.fastutil.objects
Class Object2BooleanFunctions.SynchronizedFunction<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction<K>
      it.unimi.dsi.fastutil.objects.Object2BooleanFunctions.SynchronizedFunction<K>

All Implemented Interfaces:

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

Direct Known Subclasses:

Object2BooleanMaps.SynchronizedMap

Enclosing class:

Object2BooleanFunctions

public static class Object2BooleanFunctions.SynchronizedFunction<K>
extends AbstractObject2BooleanFunction<K>
implements Serializable

A synchronized 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	get(Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
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	put(K k, Boolean v) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
Boolean	remove(Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
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 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: Object2BooleanFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2BooleanFunction<K>

Overrides:

defaultReturnValue in class AbstractObject2BooleanFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(boolean defRetValue)

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>

Overrides:

defaultReturnValue in class AbstractObject2BooleanFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Object2BooleanFunction.defaultReturnValue()

put

public boolean put(K k,
                   boolean v)

Description copied from interface: Object2BooleanFunction

Adds a pair to the map.

Specified by:

put in interface Object2BooleanFunction<K>

Overrides:

put in class AbstractObject2BooleanFunction<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 AbstractObject2BooleanFunction<K>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object

put

public Boolean put(K k,
                   Boolean v)

Description copied from class: AbstractObject2BooleanFunction

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>

Overrides:

put in class AbstractObject2BooleanFunction<K>

Parameters:

k - the key.

v - the value.

Returns:

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

See Also:

Map.put(Object,Object)

get

public Boolean get(Object k)

Description copied from class: AbstractObject2BooleanFunction

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>

Overrides:

get in class AbstractObject2BooleanFunction<K>

Parameters:

k - the key.

Returns:

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

See Also:

Map.get(Object)

remove

public Boolean remove(Object k)

Description copied from class: AbstractObject2BooleanFunction

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>

Overrides:

remove in class AbstractObject2BooleanFunction<K>

Returns:

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

See Also:

Map.remove(Object)

removeBoolean

public boolean removeBoolean(Object k)

Description copied from interface: Object2BooleanFunction

Removes the mapping with the given key.

Specified by:

removeBoolean in interface Object2BooleanFunction<K>

Overrides:

removeBoolean in class AbstractObject2BooleanFunction<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: Object2BooleanFunction

Returns the value to which the given key is mapped.

Specified by:

getBoolean in interface Object2BooleanFunction<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)