Package gnu.trove.impl.sync

Class TSynchronizedCharDoubleMap

java.lang.Object

gnu.trove.impl.sync.TSynchronizedCharDoubleMap

All Implemented Interfaces:

TCharDoubleMap, java.io.Serializable

public class TSynchronizedCharDoubleMap
extends java.lang.Object
implements TCharDoubleMap, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TSynchronizedCharDoubleMap(TCharDoubleMap m)
TSynchronizedCharDoubleMap(TCharDoubleMap m, java.lang.Object mutex)

Method Summary

Modifier and Type	Method	Description
double	adjustOrPutValue(char key, double adjust_amount, double put_amount)	Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(char key, double amount)	Adjusts the primitive value mapped to key.
void	clear()	Empties the map.
boolean	containsKey(char key)	Checks for the present of key in the keys of the map.
boolean	containsValue(double value)	Checks for the presence of val in the values of the map.
boolean	equals(java.lang.Object o)
boolean	forEachEntry(TCharDoubleProcedure procedure)	Executes procedure for each key/value entry in the map.
boolean	forEachKey(TCharProcedure procedure)	Executes procedure for each key in the map.
boolean	forEachValue(TDoubleProcedure procedure)	Executes procedure for each value in the map.
double	get(char key)	Retrieves the value for key.
char	getNoEntryKey()	Returns the value that will be returned from TCharDoubleMap.get(char) or TCharDoubleMap.put(char, double) if no entry exists for a given key.
double	getNoEntryValue()	Returns the value that will be returned from TCharDoubleMap.get(char) or TCharDoubleMap.put(char, double) if no entry exists for a given key.
int	hashCode()
boolean	increment(char key)	Increments the primitive value mapped to key by 1
boolean	isEmpty()	Returns true if this map contains no key-value mappings.
TCharDoubleIterator	iterator()
char[]	keys()	Returns the keys of the map as an array of char values.
char[]	keys(char[] array)	Returns the keys of the map.
TCharSet	keySet()	Returns the keys of the map as a TCharSet
double	put(char key, double value)	Inserts a key/value pair into the map.
void	putAll(TCharDoubleMap map)	Put all the entries from the given map into this map.
void	putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Double> map)	Put all the entries from the given Map into this map.
double	putIfAbsent(char key, double value)	Inserts a key/value pair into the map if the specified key is not already associated with a value.
double	remove(char key)	Deletes a key/value pair from the map.
boolean	retainEntries(TCharDoubleProcedure 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(TDoubleFunction function)	Transform the values in this map using function.
TDoubleCollection	valueCollection()	Returns the values of the map as a TDoubleCollection
double[]	values()	Returns the values of the map as an array of #e# values.
double[]	values(double[] 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

TSynchronizedCharDoubleMap

public TSynchronizedCharDoubleMap(TCharDoubleMap m)

TSynchronizedCharDoubleMap

public TSynchronizedCharDoubleMap(TCharDoubleMap m,
                                  java.lang.Object mutex)

Method Detail

size

public int size()

Description copied from interface: TCharDoubleMap

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

Specified by:

size in interface TCharDoubleMap

Returns:

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

isEmpty

public boolean isEmpty()

Description copied from interface: TCharDoubleMap

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

Specified by:

isEmpty in interface TCharDoubleMap

Returns:

true if this map contains no key-value mappings

containsKey

public boolean containsKey(char key)

Description copied from interface: TCharDoubleMap

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

Specified by:

containsKey in interface TCharDoubleMap

containsValue

public boolean containsValue(double value)

Description copied from interface: TCharDoubleMap

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

Specified by:

containsValue in interface TCharDoubleMap

get

public double get(char key)

Description copied from interface: TCharDoubleMap

Retrieves the value for key.

Specified by:

get in interface TCharDoubleMap

Returns:

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

put

public double put(char key,
                  double value)

Description copied from interface: TCharDoubleMap

Inserts a key/value pair into the map.

Specified by:

put in interface TCharDoubleMap

Returns:

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

remove

public double remove(char key)

Description copied from interface: TCharDoubleMap

Deletes a key/value pair from the map.

Specified by:

remove in interface TCharDoubleMap

Parameters:

key - an char value

Returns:

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

putAll

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

Description copied from interface: TCharDoubleMap

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

Specified by:

putAll in interface TCharDoubleMap

Parameters:

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

putAll

public void putAll(TCharDoubleMap map)

Description copied from interface: TCharDoubleMap

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

Specified by:

putAll in interface TCharDoubleMap

Parameters:

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

clear

public void clear()

Description copied from interface: TCharDoubleMap

Empties the map.

Specified by:

clear in interface TCharDoubleMap

keySet

public TCharSet keySet()

Description copied from interface: TCharDoubleMap

Returns the keys of the map as a TCharSet

Specified by:

keySet in interface TCharDoubleMap

Returns:

the keys of the map as a TCharSet

keys

public char[] keys()

Description copied from interface: TCharDoubleMap

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

Specified by:

keys in interface TCharDoubleMap

Returns:

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

keys

public char[] keys(char[] array)

Description copied from interface: TCharDoubleMap

Returns the keys of the map.

Specified by:

keys in interface TCharDoubleMap

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

Description copied from interface: TCharDoubleMap

Returns the values of the map as a TDoubleCollection

Specified by:

valueCollection in interface TCharDoubleMap

Returns:

the values of the map as a TDoubleCollection

values

public double[] values()

Description copied from interface: TCharDoubleMap

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

Specified by:

values in interface TCharDoubleMap

Returns:

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

values

public double[] values(double[] array)

Description copied from interface: TCharDoubleMap

Returns the values of the map using an existing array.

Specified by:

values in interface TCharDoubleMap

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 TCharDoubleIterator iterator()

Specified by:

iterator in interface TCharDoubleMap

Returns:

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

getNoEntryKey

public char getNoEntryKey()

Description copied from interface: TCharDoubleMap

Returns the value that will be returned from TCharDoubleMap.get(char) or TCharDoubleMap.put(char, double) 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 TCharDoubleMap

Returns:

the value that represents a null key in this collection.

getNoEntryValue

public double getNoEntryValue()

Description copied from interface: TCharDoubleMap

Returns the value that will be returned from TCharDoubleMap.get(char) or TCharDoubleMap.put(char, double) 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 TCharDoubleMap

Returns:

the value that represents a null value in this collection.

putIfAbsent

public double putIfAbsent(char key,
                          double value)

Description copied from interface: TCharDoubleMap

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

Specified by:

putIfAbsent in interface TCharDoubleMap

Returns:

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

forEachKey

public boolean forEachKey(TCharProcedure procedure)

Description copied from interface: TCharDoubleMap

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TCharDoubleMap

Parameters:

procedure - a TCharProcedure value

Returns:

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

forEachValue

public boolean forEachValue(TDoubleProcedure procedure)

Description copied from interface: TCharDoubleMap

Executes procedure for each value in the map.

Specified by:

forEachValue in interface TCharDoubleMap

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(TCharDoubleProcedure procedure)

Description copied from interface: TCharDoubleMap

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

Specified by:

forEachEntry in interface TCharDoubleMap

Parameters:

procedure - a TOCharDoubleProcedure value

Returns:

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

transformValues

public void transformValues(TDoubleFunction function)

Description copied from interface: TCharDoubleMap

Transform the values in this map using function.

Specified by:

transformValues in interface TCharDoubleMap

Parameters:

function - a TDoubleFunction value

retainEntries

public boolean retainEntries(TCharDoubleProcedure procedure)

Description copied from interface: TCharDoubleMap

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

Specified by:

retainEntries in interface TCharDoubleMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

increment

public boolean increment(char key)

Description copied from interface: TCharDoubleMap

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TCharDoubleMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

public boolean adjustValue(char key,
                           double amount)

Description copied from interface: TCharDoubleMap

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TCharDoubleMap

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 double adjustOrPutValue(char key,
                               double adjust_amount,
                               double put_amount)

Description copied from interface: TCharDoubleMap

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 TCharDoubleMap

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