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