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