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