Package gnu.trove.map
Interface TObjectCharMap<K>
- All Known Implementing Classes:
TObjectCharCustomHashMap
,TObjectCharHashMap
,TSynchronizedObjectCharMap
,TUnmodifiableObjectCharMap
public interface TObjectCharMap<K>
Interface for a primitive map of Object keys and char values.
-
Method Summary
Modifier and TypeMethodDescriptionchar
adjustOrPutValue
(K key, char adjust_amount, char put_amount) Adds an amount to the primitive value mapped to the key if the key is present in the map.boolean
adjustValue
(K key, char amount) Adds an amount to the primitive value mapped to key.void
clear()
Removes all of the mappings from this map (optional operation).boolean
containsKey
(Object key) Checks for the present of key in the keys of the map.boolean
containsValue
(char value) Checks for the presence of val in the values of the map.boolean
Compares the specified object with this map for equality.boolean
forEachEntry
(TObjectCharProcedure<? super K> procedure) Executes procedure for each key/value entry in the map.boolean
forEachKey
(TObjectProcedure<? super K> procedure) Executes procedure for each key in the map.boolean
forEachValue
(TCharProcedure procedure) Executes procedure for each value in the map.char
Retrieves the value for key.char
Returns the value that will be returned fromget(java.lang.Object)
orput(K, char)
if no entry exists for a given key.int
hashCode()
Returns the hash code value for this map.boolean
Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.iterator()
Returns a TObjectCharIterator with access to this map's keys and values.Object[]
keys()
Returns a copy of the keys of the map as an array.K[]
Returns a copy of the keys of the map as an array.keySet()
Returns aSet
view of the keys contained in this map.char
Inserts a key/value pair into the map.void
putAll
(TObjectCharMap<? extends K> map) Put all the entries from the given map into this map.void
Copies all of the mappings from the specified map to this map (optional operation).char
putIfAbsent
(K key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.char
Deletes a key/value pair from the map.boolean
retainEntries
(TObjectCharProcedure<? super K> procedure) Retains only those entries in the map for which the procedure returns a true value.int
size()
Returns the number of key-value mappings in this map.void
transformValues
(TCharFunction function) Transform the values in this map using function.Returns aTCharCollection
view of the values contained in this map.char[]
values()
Returns the values of the map as an array of char values.char[]
values
(char[] array) Returns the values of the map using an existing array.
-
Method Details
-
getNoEntryValue
char getNoEntryValue()Returns the value that will be returned fromget(java.lang.Object)
orput(K, 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.
-
size
int size()Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.- Returns:
- the number of key-value mappings in this map
-
isEmpty
boolean isEmpty()Returns true if this map contains no key-value mappings.- Returns:
- true if this map contains no key-value mappings
-
containsKey
Checks for the present of key in the keys of the map. -
containsValue
boolean containsValue(char value) Checks for the presence of val in the values of the map. -
get
Retrieves the value for key.- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
put
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
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Parameters:
key
- key with which the specified value is to be associatedvalue
- an char value to be associated with the specified key- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
remove
Deletes a key/value pair from the map.- Parameters:
key
- an#k#
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
getNoEntryValue()
).
-
putAll
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Parameters:
m
- mappings to be stored in this map- Throws:
UnsupportedOperationException
- if the putAll operation is not supported by this mapClassCastException
- if the class of a key or value in the specified map prevents it from being stored in this mapNullPointerException
- if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or valuesIllegalArgumentException
- if some property of a key or value in the specified map prevents it from being stored in 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.
-
clear
void clear()Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.- Throws:
UnsupportedOperationException
- if the clear operation is not supported by this map
-
keySet
Returns aSet
view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.- Returns:
- a set view of the keys contained in this map
-
keys
Object[] keys()Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Returns:
- a copy of the keys of the map as an array.
-
keys
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- 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 aTCharCollection
view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the TCharIterator.remove, TCharCollection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.- Returns:
- a collection view of the values contained in this map
-
values
char[] values()Returns the values of the map as an array of char values. Changes to the array of values will not be reflected in the map nor vice-versa.- Returns:
- the values of the map as an array of char values.
-
values
char[] values(char[] array) Returns the values of the map using an existing array. Changes to the array of values will not be reflected in the map nor vice-versa.- 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 char values.
-
iterator
TObjectCharIterator<K> iterator()Returns a TObjectCharIterator with access to this map's keys and values.- Returns:
- a TObjectCharIterator with access to this map's keys and values.
-
increment
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
Adds an amount to the primitive value mapped to key. If the key does not exist, the map is not modified (key-value is not inserted).- Parameters:
key
- the key of the value to incrementamount
- the amount to add to the value; may be positive, zero, or negative- Returns:
- true if a mapping was found and modified
- See Also:
-
adjustOrPutValue
Adds an amount to 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 add to the value; may be positive, zero, or negativeput_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
-
forEachKey
Executes procedure for each key in the map.- Parameters:
procedure
- aTObjectProcedure
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
- aTCharProcedure
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
- aTOObjectCharProcedure
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.
-
equals
Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface. -
hashCode
int hashCode()Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract ofObject.hashCode()
.
-