Package gnu.trove.impl.unmodifiable
Class TUnmodifiableCharIntMap
- java.lang.Object
-
- gnu.trove.impl.unmodifiable.TUnmodifiableCharIntMap
-
- All Implemented Interfaces:
TCharIntMap
,java.io.Serializable
public class TUnmodifiableCharIntMap extends java.lang.Object implements TCharIntMap, java.io.Serializable
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TUnmodifiableCharIntMap(TCharIntMap m)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
adjustOrPutValue(char key, int adjust_amount, int put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map.boolean
adjustValue(char key, int amount)
Adjusts the primitive value mapped to key.void
clear()
Empties the map.boolean
containsKey(char key)
Checks for the present of key in the keys of the map.boolean
containsValue(int val)
Checks for the presence of val in the values of the map.boolean
equals(java.lang.Object o)
boolean
forEachEntry(TCharIntProcedure procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TCharProcedure procedure)
Executes procedure for each key in the map.boolean
forEachValue(TIntProcedure procedure)
Executes procedure for each value in the map.int
get(char key)
Retrieves the value for key.char
getNoEntryKey()
Returns the value that will be returned fromTCharIntMap.get(char)
orTCharIntMap.put(char, int)
if no entry exists for a given key.int
getNoEntryValue()
Returns the value that will be returned fromTCharIntMap.get(char)
orTCharIntMap.put(char, int)
if no entry exists for a given key.int
hashCode()
boolean
increment(char key)
Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.TCharIntIterator
iterator()
char[]
keys()
Returns the keys of the map as an array of char values.char[]
keys(char[] array)
Returns the keys of the map.TCharSet
keySet()
Returns the keys of the map as a TCharSetint
put(char key, int value)
Inserts a key/value pair into the map.void
putAll(TCharIntMap m)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> map)
Put all the entries from the given Map into this map.int
putIfAbsent(char key, int value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.int
remove(char key)
Deletes a key/value pair from the map.boolean
retainEntries(TCharIntProcedure 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.java.lang.String
toString()
void
transformValues(TIntFunction function)
Transform the values in this map using function.TIntCollection
valueCollection()
Returns the values of the map as a TIntCollectionint[]
values()
Returns the values of the map as an array of #e# values.int[]
values(int[] array)
Returns the values of the map using an existing array.
-
-
-
Constructor Detail
-
TUnmodifiableCharIntMap
public TUnmodifiableCharIntMap(TCharIntMap m)
-
-
Method Detail
-
size
public int size()
Description copied from interface:TCharIntMap
Returns an int value that is the number of elements in the map.- Specified by:
size
in interfaceTCharIntMap
- Returns:
- an int value that is the number of elements in the map.
-
isEmpty
public boolean isEmpty()
Description copied from interface:TCharIntMap
Returns true if this map contains no key-value mappings.- Specified by:
isEmpty
in interfaceTCharIntMap
- Returns:
- true if this map contains no key-value mappings
-
containsKey
public boolean containsKey(char key)
Description copied from interface:TCharIntMap
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTCharIntMap
-
containsValue
public boolean containsValue(int val)
Description copied from interface:TCharIntMap
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTCharIntMap
-
get
public int get(char key)
Description copied from interface:TCharIntMap
Retrieves the value for key.- Specified by:
get
in interfaceTCharIntMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharIntMap.getNoEntryValue()
).
-
put
public int put(char key, int value)
Description copied from interface:TCharIntMap
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTCharIntMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharIntMap.getNoEntryValue()
).
-
remove
public int remove(char key)
Description copied from interface:TCharIntMap
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTCharIntMap
- Parameters:
key
- anchar
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharIntMap.getNoEntryValue()
).
-
putAll
public void putAll(TCharIntMap m)
Description copied from interface:TCharIntMap
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTCharIntMap
- Parameters:
m
- The map from which entries will be obtained to put into this map.
-
putAll
public void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> map)
Description copied from interface:TCharIntMap
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTCharIntMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
clear
public void clear()
Description copied from interface:TCharIntMap
Empties the map.- Specified by:
clear
in interfaceTCharIntMap
-
keySet
public TCharSet keySet()
Description copied from interface:TCharIntMap
Returns the keys of the map as a TCharSet- Specified by:
keySet
in interfaceTCharIntMap
- Returns:
- the keys of the map as a TCharSet
-
keys
public char[] keys()
Description copied from interface:TCharIntMap
Returns the keys of the map as an array of char values.- Specified by:
keys
in interfaceTCharIntMap
- Returns:
- the keys of the map as an array of char values.
-
keys
public char[] keys(char[] array)
Description copied from interface:TCharIntMap
Returns the keys of the map.- Specified by:
keys
in interfaceTCharIntMap
- 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
public TIntCollection valueCollection()
Description copied from interface:TCharIntMap
Returns the values of the map as a TIntCollection- Specified by:
valueCollection
in interfaceTCharIntMap
- Returns:
- the values of the map as a TIntCollection
-
values
public int[] values()
Description copied from interface:TCharIntMap
Returns the values of the map as an array of #e# values.- Specified by:
values
in interfaceTCharIntMap
- Returns:
- the values of the map as an array of #e# values.
-
values
public int[] values(int[] array)
Description copied from interface:TCharIntMap
Returns the values of the map using an existing array.- Specified by:
values
in interfaceTCharIntMap
- 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
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getNoEntryKey
public char getNoEntryKey()
Description copied from interface:TCharIntMap
Returns the value that will be returned fromTCharIntMap.get(char)
orTCharIntMap.put(char, int)
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 interfaceTCharIntMap
- Returns:
- the value that represents a null key in this collection.
-
getNoEntryValue
public int getNoEntryValue()
Description copied from interface:TCharIntMap
Returns the value that will be returned fromTCharIntMap.get(char)
orTCharIntMap.put(char, int)
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 interfaceTCharIntMap
- Returns:
- the value that represents a null value in this collection.
-
forEachKey
public boolean forEachKey(TCharProcedure procedure)
Description copied from interface:TCharIntMap
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTCharIntMap
- Parameters:
procedure
- aTCharProcedure
value- Returns:
- false if the loop over the keys terminated because the procedure returned false for some key.
-
forEachValue
public boolean forEachValue(TIntProcedure procedure)
Description copied from interface:TCharIntMap
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTCharIntMap
- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
public boolean forEachEntry(TCharIntProcedure procedure)
Description copied from interface:TCharIntMap
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTCharIntMap
- Parameters:
procedure
- aTOCharIntProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
iterator
public TCharIntIterator iterator()
- Specified by:
iterator
in interfaceTCharIntMap
- Returns:
- a TCharIntIterator with access to this map's keys and values
-
putIfAbsent
public int putIfAbsent(char key, int value)
Description copied from interface:TCharIntMap
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTCharIntMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TCharIntMap.getNoEntryValue()
).
-
transformValues
public void transformValues(TIntFunction function)
Description copied from interface:TCharIntMap
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTCharIntMap
- Parameters:
function
- aTIntFunction
value
-
retainEntries
public boolean retainEntries(TCharIntProcedure procedure)
Description copied from interface:TCharIntMap
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTCharIntMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(char key)
Description copied from interface:TCharIntMap
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTCharIntMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(char key, int amount)
Description copied from interface:TCharIntMap
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTCharIntMap
- 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 int adjustOrPutValue(char key, int adjust_amount, int put_amount)
Description copied from interface:TCharIntMap
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 interfaceTCharIntMap
- 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
-
-