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