Package gnu.trove.impl.unmodifiable
Class TUnmodifiableLongCharMap
java.lang.Object
gnu.trove.impl.unmodifiable.TUnmodifiableLongCharMap
- All Implemented Interfaces:
TLongCharMap
,Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionchar
adjustOrPutValue
(long 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
(long key, char amount) Adjusts the primitive value mapped to key.void
clear()
Empties the map.boolean
containsKey
(long 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
boolean
forEachEntry
(TLongCharProcedure procedure) Executes procedure for each key/value entry in the map.boolean
forEachKey
(TLongProcedure procedure) Executes procedure for each key in the map.boolean
forEachValue
(TCharProcedure procedure) Executes procedure for each value in the map.char
get
(long key) Retrieves the value for key.long
Returns the value that will be returned fromTLongCharMap.get(long)
orTLongCharMap.put(long, char)
if no entry exists for a given key.char
Returns the value that will be returned fromTLongCharMap.get(long)
orTLongCharMap.put(long, char)
if no entry exists for a given key.int
hashCode()
boolean
increment
(long key) Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.iterator()
long[]
keys()
Returns the keys of the map as an array of long values.long[]
keys
(long[] array) Returns the keys of the map.keySet()
Returns the keys of the map as a TLongSetchar
put
(long key, char value) Inserts a key/value pair into the map.void
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
(long key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.char
remove
(long key) Deletes a key/value pair from the map.boolean
retainEntries
(TLongCharProcedure 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.toString()
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.
-
Constructor Details
-
TUnmodifiableLongCharMap
-
-
Method Details
-
size
public int size()Description copied from interface:TLongCharMap
Returns an int value that is the number of elements in the map.- Specified by:
size
in interfaceTLongCharMap
- Returns:
- an int value that is the number of elements in the map.
-
isEmpty
public boolean isEmpty()Description copied from interface:TLongCharMap
Returns true if this map contains no key-value mappings.- Specified by:
isEmpty
in interfaceTLongCharMap
- Returns:
- true if this map contains no key-value mappings
-
containsKey
public boolean containsKey(long key) Description copied from interface:TLongCharMap
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTLongCharMap
-
containsValue
public boolean containsValue(char val) Description copied from interface:TLongCharMap
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTLongCharMap
-
get
public char get(long key) Description copied from interface:TLongCharMap
Retrieves the value for key.- Specified by:
get
in interfaceTLongCharMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
put
public char put(long key, char value) Description copied from interface:TLongCharMap
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTLongCharMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
remove
public char remove(long key) Description copied from interface:TLongCharMap
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTLongCharMap
- Parameters:
key
- anlong
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
putAll
Description copied from interface:TLongCharMap
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTLongCharMap
- Parameters:
m
- The map from which entries will be obtained to put into this map.
-
putAll
Description copied from interface:TLongCharMap
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTLongCharMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
clear
public void clear()Description copied from interface:TLongCharMap
Empties the map.- Specified by:
clear
in interfaceTLongCharMap
-
keySet
Description copied from interface:TLongCharMap
Returns the keys of the map as a TLongSet- Specified by:
keySet
in interfaceTLongCharMap
- Returns:
- the keys of the map as a TLongSet
-
keys
public long[] keys()Description copied from interface:TLongCharMap
Returns the keys of the map as an array of long values.- Specified by:
keys
in interfaceTLongCharMap
- Returns:
- the keys of the map as an array of long values.
-
keys
public long[] keys(long[] array) Description copied from interface:TLongCharMap
Returns the keys of the map.- Specified by:
keys
in interfaceTLongCharMap
- 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
Description copied from interface:TLongCharMap
Returns the values of the map as a TCharCollection- Specified by:
valueCollection
in interfaceTLongCharMap
- Returns:
- the values of the map as a TCharCollection
-
values
public char[] values()Description copied from interface:TLongCharMap
Returns the values of the map as an array of #e# values.- Specified by:
values
in interfaceTLongCharMap
- Returns:
- the values of the map as an array of #e# values.
-
values
public char[] values(char[] array) Description copied from interface:TLongCharMap
Returns the values of the map using an existing array.- Specified by:
values
in interfaceTLongCharMap
- 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.
-
equals
-
hashCode
public int hashCode() -
toString
-
getNoEntryKey
public long getNoEntryKey()Description copied from interface:TLongCharMap
Returns the value that will be returned fromTLongCharMap.get(long)
orTLongCharMap.put(long, char)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Specified by:
getNoEntryKey
in interfaceTLongCharMap
- Returns:
- the value that represents a null key in this collection.
-
getNoEntryValue
public char getNoEntryValue()Description copied from interface:TLongCharMap
Returns the value that will be returned fromTLongCharMap.get(long)
orTLongCharMap.put(long, char)
if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.- Specified by:
getNoEntryValue
in interfaceTLongCharMap
- Returns:
- the value that represents a null value in this collection.
-
forEachKey
Description copied from interface:TLongCharMap
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTLongCharMap
- Parameters:
procedure
- aTLongProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
Description copied from interface:TLongCharMap
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTLongCharMap
- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
Description copied from interface:TLongCharMap
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTLongCharMap
- Parameters:
procedure
- aTOLongCharProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
iterator
- Specified by:
iterator
in interfaceTLongCharMap
- Returns:
- a TLongCharIterator with access to this map's keys and values
-
putIfAbsent
public char putIfAbsent(long key, char value) Description copied from interface:TLongCharMap
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTLongCharMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
transformValues
Description copied from interface:TLongCharMap
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTLongCharMap
- Parameters:
function
- aTCharFunction
value
-
retainEntries
Description copied from interface:TLongCharMap
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTLongCharMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(long key) Description copied from interface:TLongCharMap
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTLongCharMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(long key, char amount) Description copied from interface:TLongCharMap
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTLongCharMap
- 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
public char adjustOrPutValue(long key, char adjust_amount, char put_amount) Description copied from interface:TLongCharMap
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.- Specified by:
adjustOrPutValue
in interfaceTLongCharMap
- 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
-