Package gnu.trove.map
Interface TIntCharMap
- All Known Implementing Classes:
TIntCharHashMap
,TSynchronizedIntCharMap
,TUnmodifiableIntCharMap
public interface TIntCharMap
Interface for a primitive map of int keys and char values.
-
Method Summary
Modifier and TypeMethodDescriptionchar
adjustOrPutValue
(int key, char adjust_amount, char put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.boolean
adjustValue
(int key, char 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
(char val) Checks for the presence of val in the values of the map.boolean
forEachEntry
(TIntCharProcedure 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
(TCharProcedure procedure) Executes procedure for each value in the map.char
get
(int key) Retrieves the value for key.int
Returns the value that will be returned fromget(int)
orput(int, char)
if no entry exists for a given key.char
Returns the value that will be returned fromget(int)
orput(int, char)
if no entry exists for a given key.boolean
increment
(int key) Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.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.keySet()
Returns the keys of the map as a TIntSetchar
put
(int key, char value) Inserts a key/value pair into the map.void
putAll
(TIntCharMap map) Put all the entries from the given map into this map.void
Put all the entries from the given Map into this map.char
putIfAbsent
(int key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.char
remove
(int key) Deletes a key/value pair from the map.boolean
retainEntries
(TIntCharProcedure 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
(TCharFunction function) Transform the values in this map using function.Returns the values of the map as a TCharCollectionchar[]
values()
Returns the values of the map as an array of #e# values.char[]
values
(char[] array) Returns the values of the map using an existing array.
-
Method Details
-
getNoEntryKey
int getNoEntryKey()Returns the value that will be returned fromget(int)
orput(int, char)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Returns:
- the value that represents a null key in this collection.
-
getNoEntryValue
char getNoEntryValue()Returns the value that will be returned fromget(int)
orput(int, char)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Returns:
- the value that represents a null value in this collection.
-
put
char put(int key, char value) Inserts a key/value pair into the map.- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
putIfAbsent
char putIfAbsent(int key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
putAll
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
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
char get(int key) Retrieves the value for key.- 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
char remove(int key) Deletes a key/value pair from the map.- Parameters:
key
- anint
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
TCharCollection valueCollection()Returns the values of the map as a TCharCollection- Returns:
- the values of the map as a TCharCollection
-
values
char[] 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
char[] values(char[] 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(char val) Checks for the presence of val in the values of the map. -
containsKey
boolean containsKey(int key) Checks for the present of key in the keys of the map. -
iterator
TIntCharIterator iterator()- Returns:
- a TIntCharIterator with access to this map's keys and values
-
forEachKey
Executes procedure for each key in the map.- Parameters:
procedure
- aTIntProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
Executes procedure for each value in the map.- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
Executes procedure for each key/value entry in the map.- Parameters:
procedure
- aTOIntCharProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
transformValues
Transform the values in this map using function.- Parameters:
function
- aTCharFunction
value
-
retainEntries
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, char amount) Adjusts the primitive value mapped to key.- Parameters:
key
- the key of the value to incrementamount
- the amount to adjust the value by.- Returns:
- true if a mapping was found and modified.
-
adjustOrPutValue
char adjustOrPutValue(int key, char adjust_amount, char put_amount) Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to adjust the value byput_amount
- the value put into the map if the key is not present- Returns:
- the value present in the map after the adjustment or put operation
-