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