it.unimi.dsi.fastutil.bytes
Interface Byte2IntMap

All Superinterfaces:
Map
All Known Subinterfaces:
Byte2IntSortedMap
All Known Implementing Classes:
AbstractByte2IntMap, Byte2IntAVLTreeMap, Byte2IntLinkedOpenHashMap, Byte2IntOpenHashMap, Byte2IntRBTreeMap

public interface Byte2IntMap
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 Byte2IntMap.Entry
          A type-specific Map.Entry; provides some additional methods to access its content reducing type juggling.
 
Method Summary
 boolean containsKey(byte key)
           
 boolean containsValue(int value)
           
 int defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(int rv)
          Sets the default return value.
 int get(byte key)
          Returns the value to which the given key is mapped.
 int getDefRetValue()
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 int put(byte key, int value)
          Adds a pair to the map.
 int remove(byte key)
          Removes the mapping with the given key.
 void setDefRetValue(int 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 int put(byte key,
               int 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)

get

public int get(byte 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)

remove

public int remove(byte 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)

containsKey

public boolean containsKey(byte key)
See Also:
Map.containsKey(Object)

containsValue

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

setDefRetValue

public void setDefRetValue(int 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 int 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(int 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 int defaultReturnValue()
Gets the default return value.

Returns:
the current default return value.