it.unimi.dsi.fastutil.longs
Interface Long2BooleanMap

All Superinterfaces:
Map
All Known Subinterfaces:
Long2BooleanSortedMap
All Known Implementing Classes:
AbstractLong2BooleanMap, Long2BooleanAVLTreeMap, Long2BooleanLinkedOpenHashMap, Long2BooleanOpenHashMap, Long2BooleanRBTreeMap

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

containsValue

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

setDefRetValue

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

Returns:
the current default return value.