GNU Trove

gnu.trove.map
Interface TIntByteMap

All Known Implementing Classes:
TIntByteHashMap

public interface TIntByteMap

Interface for a primitive map of int keys and byte values.


Method Summary
 byte adjustOrPutValue(int key, byte adjust_amount, byte put_amount)
          Adjusts the primitive value mapped to the key if the key is present in the map.
 boolean adjustValue(int key, byte amount)
          Adjusts the primitive value mapped to key.
 void clear()
          Empties the map.
 boolean containsKey(int key)
          Checks for the present of key in the keys of the map.
 boolean containsValue(byte val)
          Checks for the presence of val in the values of the map.
 boolean forEachEntry(TIntByteProcedure procedure)
          Executes procedure for each key/value entry in the map.
 boolean forEachKey(TIntProcedure procedure)
          Executes procedure for each key in the map.
 boolean forEachValue(TByteProcedure procedure)
          Executes procedure for each value in the map.
 byte get(int key)
          Retrieves the value for key
 int getNoEntryKey()
          Returns the value that will be returned from get(int) or put(int, byte) if no entry exists for a given key.
 byte getNoEntryValue()
          Returns the value that will be returned from get(int) or put(int, byte) if no entry exists for a given key.
 boolean increment(int key)
          Increments the primitive value mapped to key by 1
 boolean isEmpty()
          Returns true if this map contains no key-value mappings.
 TIntByteIterator iterator()
           
 int[] keys()
          Returns the keys of the map as an array of int values.
 int[] keys(int[] array)
          Returns the keys of the map.
 TIntSet keySet()
          Returns the keys of the map as a TIntSet
 byte put(int key, byte value)
          Inserts a key/value pair into the map.
 void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Byte> map)
          Put all the entries from the given Map into this map.
 void putAll(TIntByteMap map)
          Put all the entries from the given map into this map.
 byte putIfAbsent(int key, byte value)
          Inserts a key/value pair into the map if the specified key is not already associated with a value.
 byte remove(int key)
          Deletes a key/value pair from the map.
 boolean retainEntries(TIntByteProcedure procedure)
          Retains only those entries in the map for which the procedure returns a true value.
 int size()
          Returns an int value that is the number of elements in the map.
 void transformValues(TByteFunction function)
          Transform the values in this map using function.
 TByteCollection valueCollection()
          Returns the values of the map as a TByteCollection
 byte[] values()
          Returns the values of the map as an array of #e# values.
 byte[] values(byte[] array)
          Returns the values of the map using an existing array.
 

Method Detail

getNoEntryKey

int getNoEntryKey()
Returns the value that will be returned from get(int) or put(int, byte) if no entry exists for a given key. The default value is generally zero, but can be changed during construction of the collection.

Returns:
the value that represents a null key in this collection.

getNoEntryValue

byte getNoEntryValue()
Returns the value that will be returned from get(int) or put(int, byte) if no entry exists for a given key. The default value is generally zero, but can be changed during construction of the collection.

Returns:
the value that represents a null value in this collection.

put

byte put(int key,
         byte value)
Inserts a key/value pair into the map.

Parameters:
key - an int value
value - an byte value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

putIfAbsent

byte putIfAbsent(int key,
                 byte value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.

Parameters:
key - an int value
value - an byte value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

putAll

void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Byte> map)
Put all the entries from the given Map into this map.

Parameters:
map - The Map from which entries will be obtained to put into this map.

putAll

void putAll(TIntByteMap map)
Put all the entries from the given map into this map.

Parameters:
map - The map from which entries will be obtained to put into this map.

get

byte get(int key)
Retrieves the value for key

Parameters:
key - an int value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

clear

void clear()
Empties the map.


isEmpty

boolean isEmpty()
Returns true if this map contains no key-value mappings.

Returns:
true if this map contains no key-value mappings

remove

byte remove(int key)
Deletes a key/value pair from the map.

Parameters:
key - an int value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

size

int size()
Returns an int value that is the number of elements in the map.

Returns:
an int value that is the number of elements in the map.

keySet

TIntSet keySet()
Returns the keys of the map as a TIntSet

Returns:
the keys of the map as a TIntSet

keys

int[] keys()
Returns the keys of the map as an array of int values.

Returns:
the keys of the map as an array of int values.

keys

int[] keys(int[] array)
Returns the keys of the map.

Parameters:
array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
Returns:
the keys of the map as an array.

valueCollection

TByteCollection valueCollection()
Returns the values of the map as a TByteCollection

Returns:
the values of the map as a TByteCollection

values

byte[] values()
Returns the values of the map as an array of #e# values.

Returns:
the values of the map as an array of #e# values.

values

byte[] values(byte[] array)
Returns the values of the map using an existing array.

Parameters:
array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
Returns:
the values of the map as an array of #e# values.

containsValue

boolean containsValue(byte val)
Checks for the presence of val in the values of the map.

Parameters:
val - an byte value
Returns:
a boolean value

containsKey

boolean containsKey(int key)
Checks for the present of key in the keys of the map.

Parameters:
key - an int value
Returns:
a boolean value

iterator

TIntByteIterator iterator()
Returns:
a TIntByteIterator with access to this map's keys and values

forEachKey

boolean forEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.

Parameters:
procedure - a TIntProcedure value
Returns:
false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

boolean forEachValue(TByteProcedure procedure)
Executes procedure for each value in the map.

Parameters:
procedure - a T#F#Procedure value
Returns:
false if the loop over the values terminated because the procedure returned false for some value.

forEachEntry

boolean forEachEntry(TIntByteProcedure procedure)
Executes procedure for each key/value entry in the map.

Parameters:
procedure - a TOIntByteProcedure value
Returns:
false if the loop over the entries terminated because the procedure returned false for some entry.

transformValues

void transformValues(TByteFunction function)
Transform the values in this map using function.

Parameters:
function - a TByteFunction value

retainEntries

boolean retainEntries(TIntByteProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.

Parameters:
procedure - determines which entries to keep
Returns:
true if the map was modified.

increment

boolean increment(int key)
Increments the primitive value mapped to key by 1

Parameters:
key - the key of the value to increment
Returns:
true if a mapping was found and modified.

adjustValue

boolean adjustValue(int key,
                    byte amount)
Adjusts the primitive value mapped to key.

Parameters:
key - the key of the value to increment
amount - the amount to adjust the value by.
Returns:
true if a mapping was found and modified.

adjustOrPutValue

byte adjustOrPutValue(int key,
                      byte adjust_amount,
                      byte put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.

Parameters:
key - the key of the value to increment
adjust_amount - the amount to adjust the value by
put_amount - the value put into the map if the key is not initial present
Returns:
the value present in the map after the adjustment or put operation

GNU Trove