Package gnu.trove.impl.sync
Class TSynchronizedObjectByteMap<K>
- java.lang.Object
-
- gnu.trove.impl.sync.TSynchronizedObjectByteMap<K>
-
- All Implemented Interfaces:
TObjectByteMap<K>
,java.io.Serializable
public class TSynchronizedObjectByteMap<K> extends java.lang.Object implements TObjectByteMap<K>, java.io.Serializable
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TSynchronizedObjectByteMap(TObjectByteMap<K> m)
TSynchronizedObjectByteMap(TObjectByteMap<K> m, java.lang.Object mutex)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte
adjustOrPutValue(K key, byte adjust_amount, byte put_amount)
Adds an amount to the primitive value mapped to the key if the key is present in the map.boolean
adjustValue(K key, byte amount)
Adds an amount to the primitive value mapped to key.void
clear()
Removes all of the mappings from this map (optional operation).boolean
containsKey(java.lang.Object key)
Checks for the present of key in the keys of the map.boolean
containsValue(byte value)
Checks for the presence of val in the values of the map.boolean
equals(java.lang.Object o)
Compares the specified object with this map for equality.boolean
forEachEntry(TObjectByteProcedure<? super K> procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TObjectProcedure<? super K> procedure)
Executes procedure for each key in the map.boolean
forEachValue(TByteProcedure procedure)
Executes procedure for each value in the map.byte
get(java.lang.Object key)
Retrieves the value for key.byte
getNoEntryValue()
Returns the value that will be returned fromTObjectByteMap.get(java.lang.Object)
orTObjectByteMap.put(K, byte)
if no entry exists for a given key.int
hashCode()
Returns the hash code value for this map.boolean
increment(K key)
Increments the primitive value mapped to key by 1boolean
isEmpty()
Returns true if this map contains no key-value mappings.TObjectByteIterator<K>
iterator()
Returns a TObjectByteIterator with access to this map's keys and values.java.lang.Object[]
keys()
Returns a copy of the keys of the map as an array.K[]
keys(K[] array)
Returns a copy of the keys of the map as an array.java.util.Set<K>
keySet()
Returns aSet
view of the keys contained in this map.byte
put(K key, byte value)
Inserts a key/value pair into the map.void
putAll(TObjectByteMap<? extends K> map)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends K,? extends java.lang.Byte> map)
Copies all of the mappings from the specified map to this map (optional operation).byte
putIfAbsent(K key, byte value)
Inserts a key/value pair into the map if the specified key is not already associated with a value.byte
remove(java.lang.Object key)
Deletes a key/value pair from the map.boolean
retainEntries(TObjectByteProcedure<? super K> procedure)
Retains only those entries in the map for which the procedure returns a true value.int
size()
Returns the number of key-value mappings in this map.java.lang.String
toString()
void
transformValues(TByteFunction function)
Transform the values in this map using function.TByteCollection
valueCollection()
Returns aTByteCollection
view of the values contained in this map.byte[]
values()
Returns the values of the map as an array of byte values.byte[]
values(byte[] array)
Returns the values of the map using an existing array.
-
-
-
Constructor Detail
-
TSynchronizedObjectByteMap
public TSynchronizedObjectByteMap(TObjectByteMap<K> m)
-
TSynchronizedObjectByteMap
public TSynchronizedObjectByteMap(TObjectByteMap<K> m, java.lang.Object mutex)
-
-
Method Detail
-
size
public int size()
Description copied from interface:TObjectByteMap
Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.- Specified by:
size
in interfaceTObjectByteMap<K>
- Returns:
- the number of key-value mappings in this map
-
isEmpty
public boolean isEmpty()
Description copied from interface:TObjectByteMap
Returns true if this map contains no key-value mappings.- Specified by:
isEmpty
in interfaceTObjectByteMap<K>
- Returns:
- true if this map contains no key-value mappings
-
containsKey
public boolean containsKey(java.lang.Object key)
Description copied from interface:TObjectByteMap
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTObjectByteMap<K>
-
containsValue
public boolean containsValue(byte value)
Description copied from interface:TObjectByteMap
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTObjectByteMap<K>
-
get
public byte get(java.lang.Object key)
Description copied from interface:TObjectByteMap
Retrieves the value for key.- Specified by:
get
in interfaceTObjectByteMap<K>
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectByteMap.getNoEntryValue()
).
-
put
public byte put(K key, byte value)
Description copied from interface:TObjectByteMap
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTObjectByteMap<K>
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectByteMap.getNoEntryValue()
).
-
remove
public byte remove(java.lang.Object key)
Description copied from interface:TObjectByteMap
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTObjectByteMap<K>
- Parameters:
key
- an#k#
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectByteMap.getNoEntryValue()
).
-
putAll
public void putAll(java.util.Map<? extends K,? extends java.lang.Byte> map)
Description copied from interface:TObjectByteMap
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Specified by:
putAll
in interfaceTObjectByteMap<K>
- Parameters:
map
- mappings to be stored in this map
-
putAll
public void putAll(TObjectByteMap<? extends K> map)
Description copied from interface:TObjectByteMap
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTObjectByteMap<K>
- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
clear
public void clear()
Description copied from interface:TObjectByteMap
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.- Specified by:
clear
in interfaceTObjectByteMap<K>
-
keySet
public java.util.Set<K> keySet()
Description copied from interface:TObjectByteMap
Returns aSet
view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.- Specified by:
keySet
in interfaceTObjectByteMap<K>
- Returns:
- a set view of the keys contained in this map
-
keys
public java.lang.Object[] keys()
Description copied from interface:TObjectByteMap
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Specified by:
keys
in interfaceTObjectByteMap<K>
- Returns:
- a copy of the keys of the map as an array.
-
keys
public K[] keys(K[] array)
Description copied from interface:TObjectByteMap
Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.- Specified by:
keys
in interfaceTObjectByteMap<K>
- 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:TObjectByteMap
Returns aTByteCollection
view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the TByteIterator.remove, TByteCollection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.- Specified by:
valueCollection
in interfaceTObjectByteMap<K>
- Returns:
- a collection view of the values contained in this map
-
values
public byte[] values()
Description copied from interface:TObjectByteMap
Returns the values of the map as an array of byte values. Changes to the array of values will not be reflected in the map nor vice-versa.- Specified by:
values
in interfaceTObjectByteMap<K>
- Returns:
- the values of the map as an array of byte values.
-
values
public byte[] values(byte[] array)
Description copied from interface:TObjectByteMap
Returns the values of the map using an existing array. Changes to the array of values will not be reflected in the map nor vice-versa.- Specified by:
values
in interfaceTObjectByteMap<K>
- 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 byte values.
-
iterator
public TObjectByteIterator<K> iterator()
Description copied from interface:TObjectByteMap
Returns a TObjectByteIterator with access to this map's keys and values.- Specified by:
iterator
in interfaceTObjectByteMap<K>
- Returns:
- a TObjectByteIterator with access to this map's keys and values.
-
getNoEntryValue
public byte getNoEntryValue()
Description copied from interface:TObjectByteMap
Returns the value that will be returned fromTObjectByteMap.get(java.lang.Object)
orTObjectByteMap.put(K, 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 interfaceTObjectByteMap<K>
- Returns:
- the value that represents a null value in this collection.
-
putIfAbsent
public byte putIfAbsent(K key, byte value)
Description copied from interface:TObjectByteMap
Inserts a key/value pair into the map if the specified key is not already associated with a value.- Specified by:
putIfAbsent
in interfaceTObjectByteMap<K>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- an byte value to be associated with the specified key- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TObjectByteMap.getNoEntryValue()
).
-
forEachKey
public boolean forEachKey(TObjectProcedure<? super K> procedure)
Description copied from interface:TObjectByteMap
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTObjectByteMap<K>
- Parameters:
procedure
- aTObjectProcedure
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:TObjectByteMap
Executes procedure for each value in the map.- Specified by:
forEachValue
in interfaceTObjectByteMap<K>
- Parameters:
procedure
- aTByteProcedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
public boolean forEachEntry(TObjectByteProcedure<? super K> procedure)
Description copied from interface:TObjectByteMap
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTObjectByteMap<K>
- Parameters:
procedure
- aTOObjectByteProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
transformValues
public void transformValues(TByteFunction function)
Description copied from interface:TObjectByteMap
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTObjectByteMap<K>
- Parameters:
function
- aTByteFunction
value
-
retainEntries
public boolean retainEntries(TObjectByteProcedure<? super K> procedure)
Description copied from interface:TObjectByteMap
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTObjectByteMap<K>
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(K key)
Description copied from interface:TObjectByteMap
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTObjectByteMap<K>
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(K key, byte amount)
Description copied from interface:TObjectByteMap
Adds an amount to the primitive value mapped to key. If the key does not exist, the map is not modified (key-value is not inserted).- Specified by:
adjustValue
in interfaceTObjectByteMap<K>
- Parameters:
key
- the key of the value to incrementamount
- the amount to add to the value; may be positive, zero, or negative- Returns:
- true if a mapping was found and modified
- See Also:
TObjectByteMap.adjustOrPutValue(Object, byte, byte)
-
adjustOrPutValue
public byte adjustOrPutValue(K key, byte adjust_amount, byte put_amount)
Description copied from interface:TObjectByteMap
Adds an amount to 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 interfaceTObjectByteMap<K>
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to add to the value; may be positive, zero, or negativeput_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
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:TObjectByteMap
Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.- Specified by:
equals
in interfaceTObjectByteMap<K>
- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- object to be compared for equality with this map- Returns:
- true if the specified object is equal to this map
-
hashCode
public int hashCode()
Description copied from interface:TObjectByteMap
Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract ofObject.hashCode()
.- Specified by:
hashCode
in interfaceTObjectByteMap<K>
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- the hash code value for this map
- See Also:
Object.equals(Object)
,TObjectByteMap.equals(Object)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-