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,java.lang.Boolean>

  Returns:

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

• containsKey

  public boolean containsKey(java.lang.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,java.lang.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,java.lang.Boolean>

  Overrides:

  clear in class AbstractReference2BooleanFunction<K>

  See Also:

  Map.clear()

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

• put

  @Deprecated
  public java.lang.Boolean put(K k,
                                           java.lang.Boolean v)

  Deprecated. Please use the corresponding type-specific method instead.
  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,java.lang.Boolean>

  Overrides:

  put in class AbstractReference2BooleanFunction<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

  @Deprecated
  public java.lang.Boolean get(java.lang.Object k)

  Deprecated. Please use the corresponding type-specific method instead.
  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,java.lang.Boolean>

  Overrides:

  get in class AbstractReference2BooleanFunction<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

  @Deprecated
  public java.lang.Boolean remove(java.lang.Object k)

  Deprecated. Please use the corresponding type-specific method instead.
  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,java.lang.Boolean>

  Overrides:

  remove in class AbstractReference2BooleanFunction<K>

  Parameters:

  k - the key.

  Returns:

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

  See Also:

  Map.remove(Object)

• removeBoolean

  public boolean removeBoolean(java.lang.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>

  Parameters:

  k - the key.

  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(java.lang.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)