it.unimi.dsi.fastutil.bytes
Interface Byte2ShortMap

All Superinterfaces:
Map
All Known Subinterfaces:
Byte2ShortSortedMap
All Known Implementing Classes:
AbstractByte2ShortMap, Byte2ShortAVLTreeMap, Byte2ShortLinkedOpenHashMap, Byte2ShortOpenHashMap, Byte2ShortRBTreeMap

public interface Byte2ShortMap
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 Byte2ShortMap.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(short value)
           
 short defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(short rv)
          Sets the default return value.
 short get(byte key)
          Returns the value to which the given key is mapped.
 short getDefRetValue()
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 short put(byte key, short value)
          Adds a pair to the map.
 short remove(byte key)
          Removes the mapping with the given key.
 void setDefRetValue(short 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 short put(byte key,
                 short 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 short 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 short 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(short value)
See Also:
Map.containsValue(Object)

setDefRetValue

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

Returns:
the current default return value.