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

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2CharFunction<K>
      extended by it.unimi.dsi.fastutil.objects.Object2CharFunctions.UnmodifiableFunction<K>
All Implemented Interfaces:
Function<K,java.lang.Character>, Object2CharFunction<K>, java.io.Serializable
Direct Known Subclasses:
Object2CharMaps.UnmodifiableMap
Enclosing class:
Object2CharFunctions

public static class Object2CharFunctions.UnmodifiableFunction<K>
extends AbstractObject2CharFunction<K>
implements java.io.Serializable

An unmodifiable wrapper class for functions.

See Also:
Serialized Form

Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(java.lang.Object k)
          Returns true if this function contains a mapping for the specified key.
 char defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(char defRetValue)
          Sets the default return value.
 char getChar(java.lang.Object k)
          Returns the value to which the given key is mapped.
 char put(K k, char v)
          Adds a pair to the map.
 char removeChar(java.lang.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.
 java.lang.String toString()
           
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2CharFunction
get, put, remove
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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.Character>
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.Character>
Parameters:
k - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

defaultReturnValue

public char defaultReturnValue()
Description copied from interface: Object2CharFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Object2CharFunction<K>
Overrides:
defaultReturnValue in class AbstractObject2CharFunction<K>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(char defRetValue)
Description copied from interface: Object2CharFunction
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 Object2CharFunction<K>
Overrides:
defaultReturnValue in class AbstractObject2CharFunction<K>
Parameters:
defRetValue - the new default return value.
See Also:
Object2CharFunction.defaultReturnValue()

put

public char put(K k,
                char v)
Description copied from interface: Object2CharFunction
Adds a pair to the map.

Specified by:
put in interface Object2CharFunction<K>
Overrides:
put in class AbstractObject2CharFunction<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.Character>
Overrides:
clear in class AbstractObject2CharFunction<K>
See Also:
Map.clear()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

removeChar

public char removeChar(java.lang.Object k)
Description copied from interface: Object2CharFunction
Removes the mapping with the given key.

Specified by:
removeChar in interface Object2CharFunction<K>
Overrides:
removeChar in class AbstractObject2CharFunction<K>
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

getChar

public char getChar(java.lang.Object k)
Description copied from interface: Object2CharFunction
Returns the value to which the given key is mapped.

Specified by:
getChar in interface Object2CharFunction<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)