it.unimi.dsi.fastutil.objects
Interface Reference2CharMap

All Superinterfaces:
Map
All Known Subinterfaces:
Reference2CharSortedMap
All Known Implementing Classes:
AbstractReference2CharMap, Reference2CharLinkedOpenHashMap, Reference2CharOpenHashMap

public interface Reference2CharMap
extends Map

A type-specific Map; provides some additional methods that use polymorphism to reduce type juggling.

See Also:
Map

Nested Class Summary
static interface Reference2CharMap.Entry
          A type-specific Map.Entry; provides some additional methods to access its content reducing type juggling.
 
Method Summary
 boolean containsValue(char value)
           
 char defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(char rv)
          Sets the default return value.
 char getChar(Object key)
          Returns the value to which the given key is mapped.
 char getDefRetValue()
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 char put(Object key, char value)
          Adds a pair to the map.
 char removeChar(Object key)
          Removes the mapping with the given key.
 void setDefRetValue(char rv)
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

put

public char put(Object key,
                char value)
Adds a pair to the map.

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:
Map.put(Object,Object)

getChar

public char getChar(Object key)
Returns the value to which the given key is mapped.

Parameters:
key - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

removeChar

public char removeChar(Object key)
Removes the mapping with the given key.

Parameters:
key -
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Map.remove(Object)

containsValue

public boolean containsValue(char value)
See Also:
Map.containsValue(Object)

setDefRetValue

public void setDefRetValue(char rv)
Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().

Sets the default return value. This value is returned by get(), put() and remove() to denote that the map does not contain the specified key. It is 0/false/null by default.

Parameters:
rv - the new default return value.
See Also:
getDefRetValue(), defaultReturnValue()

getDefRetValue

public char getDefRetValue()
Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().

Gets the default return value.

Returns:
the current default return value.
See Also:
defaultReturnValue()

defaultReturnValue

public void defaultReturnValue(char rv)
Sets the default return value. This value is returned by get(), put() and remove() to denote that the map does not contain the specified key. It is 0/false/null by default.

Parameters:
rv - the new default return value.
See Also:
defaultReturnValue()

defaultReturnValue

public char defaultReturnValue()
Gets the default return value.

Returns:
the current default return value.