Package gnu.trove.impl.sync

Class TSynchronizedShortShortMap

java.lang.Object

gnu.trove.impl.sync.TSynchronizedShortShortMap

All Implemented Interfaces:

TShortShortMap, java.io.Serializable

public class TSynchronizedShortShortMap
extends java.lang.Object
implements TShortShortMap, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TSynchronizedShortShortMap(TShortShortMap m)
TSynchronizedShortShortMap(TShortShortMap m, java.lang.Object mutex)

Method Summary

Modifier and Type	Method	Description
short	adjustOrPutValue(short key, short adjust_amount, short put_amount)	Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(short key, short 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(short value)	Checks for the presence of val in the values of the map.
boolean	equals(java.lang.Object o)
boolean	forEachEntry(TShortShortProcedure 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(TShortProcedure procedure)	Executes procedure for each value in the map.
short	get(short key)	Retrieves the value for key.
short	getNoEntryKey()	Returns the value that will be returned from TShortShortMap.get(short) or TShortShortMap.put(short, short) if no entry exists for a given key.
short	getNoEntryValue()	Returns the value that will be returned from TShortShortMap.get(short) or TShortShortMap.put(short, short) if no entry exists for a given key.
int	hashCode()
boolean	increment(short key)	Increments the primitive value mapped to key by 1
boolean	isEmpty()	Returns true if this map contains no key-value mappings.
TShortShortIterator	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 TShortSet
short	put(short key, short value)	Inserts a key/value pair into the map.
void	putAll(TShortShortMap map)	Put all the entries from the given map into this map.
void	putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Short> map)	Put all the entries from the given Map into this map.
short	putIfAbsent(short key, short value)	Inserts a key/value pair into the map if the specified key is not already associated with a value.
short	remove(short key)	Deletes a key/value pair from the map.
boolean	retainEntries(TShortShortProcedure 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(TShortFunction function)	Transform the values in this map using function.
TShortCollection	valueCollection()	Returns the values of the map as a TShortCollection
short[]	values()	Returns the values of the map as an array of #e# values.
short[]	values(short[] array)	Returns the values of the map using an existing array.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TSynchronizedShortShortMap

public TSynchronizedShortShortMap(TShortShortMap m)

TSynchronizedShortShortMap

public TSynchronizedShortShortMap(TShortShortMap m,
                                  java.lang.Object mutex)

Method Detail

size

public int size()

Description copied from interface: TShortShortMap

Returns an int value that is the number of elements in the map.

Specified by:

size in interface TShortShortMap

Returns:

an int value that is the number of elements in the map.

isEmpty

public boolean isEmpty()

Description copied from interface: TShortShortMap

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface TShortShortMap

Returns:

true if this map contains no key-value mappings

containsKey

public boolean containsKey(short key)

Description copied from interface: TShortShortMap

Checks for the present of key in the keys of the map.

Specified by:

containsKey in interface TShortShortMap

containsValue

public boolean containsValue(short value)

Description copied from interface: TShortShortMap

Checks for the presence of val in the values of the map.

Specified by:

containsValue in interface TShortShortMap

get

public short get(short key)

Description copied from interface: TShortShortMap

Retrieves the value for key.

Specified by:

get in interface TShortShortMap

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TShortShortMap.getNoEntryValue()).

put

public short put(short key,
                 short value)

Description copied from interface: TShortShortMap

Inserts a key/value pair into the map.

Specified by:

put in interface TShortShortMap

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TShortShortMap.getNoEntryValue()).

remove

public short remove(short key)

Description copied from interface: TShortShortMap

Deletes a key/value pair from the map.

Specified by:

remove in interface TShortShortMap

Parameters:

key - an short value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TShortShortMap.getNoEntryValue()).

putAll

public void putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Short> map)

Description copied from interface: TShortShortMap

Put all the entries from the given Map into this map.

Specified by:

putAll in interface TShortShortMap

Parameters:

map - The Map from which entries will be obtained to put into this map.

putAll

public void putAll(TShortShortMap map)

Description copied from interface: TShortShortMap

Put all the entries from the given map into this map.

Specified by:

putAll in interface TShortShortMap

Parameters:

map - The map from which entries will be obtained to put into this map.

clear

public void clear()

Description copied from interface: TShortShortMap

Empties the map.

Specified by:

clear in interface TShortShortMap

keySet

public TShortSet keySet()

Description copied from interface: TShortShortMap

Returns the keys of the map as a TShortSet

Specified by:

keySet in interface TShortShortMap

Returns:

the keys of the map as a TShortSet

keys

public short[] keys()

Description copied from interface: TShortShortMap

Returns the keys of the map as an array of short values.

Specified by:

keys in interface TShortShortMap

Returns:

the keys of the map as an array of short values.

keys

public short[] keys(short[] array)

Description copied from interface: TShortShortMap

Returns the keys of the map.

Specified by:

keys in interface TShortShortMap

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 TShortCollection valueCollection()

Description copied from interface: TShortShortMap

Returns the values of the map as a TShortCollection

Specified by:

valueCollection in interface TShortShortMap

Returns:

the values of the map as a TShortCollection

values

public short[] values()

Description copied from interface: TShortShortMap

Returns the values of the map as an array of #e# values.

Specified by:

values in interface TShortShortMap

Returns:

the values of the map as an array of #e# values.

values

public short[] values(short[] array)

Description copied from interface: TShortShortMap

Returns the values of the map using an existing array.

Specified by:

values in interface TShortShortMap

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.

iterator

public TShortShortIterator iterator()

Specified by:

iterator in interface TShortShortMap

Returns:

a TShortShortIterator with access to this map's keys and values

getNoEntryKey

public short getNoEntryKey()

Description copied from interface: TShortShortMap

Returns the value that will be returned from TShortShortMap.get(short) or TShortShortMap.put(short, short) 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 interface TShortShortMap

Returns:

the value that represents a null key in this collection.

getNoEntryValue

public short getNoEntryValue()

Description copied from interface: TShortShortMap

Returns the value that will be returned from TShortShortMap.get(short) or TShortShortMap.put(short, short) 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 interface TShortShortMap

Returns:

the value that represents a null value in this collection.

putIfAbsent

public short putIfAbsent(short key,
                         short value)

Description copied from interface: TShortShortMap

Inserts a key/value pair into the map if the specified key is not already associated with a value.

Specified by:

putIfAbsent in interface TShortShortMap

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TShortShortMap.getNoEntryValue()).

forEachKey

public boolean forEachKey(TShortProcedure procedure)

Description copied from interface: TShortShortMap

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TShortShortMap

Parameters:

procedure - a TShortProcedure value

Returns:

false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

public boolean forEachValue(TShortProcedure procedure)

Description copied from interface: TShortShortMap

Executes procedure for each value in the map.

Specified by:

forEachValue in interface TShortShortMap

Parameters:

procedure - a T#F#Procedure value

Returns:

false if the loop over the values terminated because the procedure returned false for some value.

forEachEntry

public boolean forEachEntry(TShortShortProcedure procedure)

Description copied from interface: TShortShortMap

Executes procedure for each key/value entry in the map.

Specified by:

forEachEntry in interface TShortShortMap

Parameters:

procedure - a TOShortShortProcedure value

Returns:

false if the loop over the entries terminated because the procedure returned false for some entry.

transformValues

public void transformValues(TShortFunction function)

Description copied from interface: TShortShortMap

Transform the values in this map using function.

Specified by:

transformValues in interface TShortShortMap

Parameters:

function - a TShortFunction value

retainEntries

public boolean retainEntries(TShortShortProcedure procedure)

Description copied from interface: TShortShortMap

Retains only those entries in the map for which the procedure returns a true value.

Specified by:

retainEntries in interface TShortShortMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

increment

public boolean increment(short key)

Description copied from interface: TShortShortMap

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TShortShortMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

public boolean adjustValue(short key,
                           short amount)

Description copied from interface: TShortShortMap

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TShortShortMap

Parameters:

key - the key of the value to increment

amount - the amount to adjust the value by.

Returns:

true if a mapping was found and modified.

adjustOrPutValue

public short adjustOrPutValue(short key,
                              short adjust_amount,
                              short put_amount)

Description copied from interface: TShortShortMap

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 interface TShortShortMap

Parameters:

key - the key of the value to increment

adjust_amount - the amount to adjust the value by

put_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)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object