Package gnu.trove.impl.unmodifiable

Class TUnmodifiableDoubleShortMap

java.lang.Object

gnu.trove.impl.unmodifiable.TUnmodifiableDoubleShortMap

All Implemented Interfaces:

TDoubleShortMap, java.io.Serializable

public class TUnmodifiableDoubleShortMap
extends java.lang.Object
implements TDoubleShortMap, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TUnmodifiableDoubleShortMap(TDoubleShortMap m)

Method Summary

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

TUnmodifiableDoubleShortMap

public TUnmodifiableDoubleShortMap(TDoubleShortMap m)

Method Detail

size

public int size()

Description copied from interface: TDoubleShortMap

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

Specified by:

size in interface TDoubleShortMap

Returns:

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

isEmpty

public boolean isEmpty()

Description copied from interface: TDoubleShortMap

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

Specified by:

isEmpty in interface TDoubleShortMap

Returns:

true if this map contains no key-value mappings

containsKey

public boolean containsKey(double key)

Description copied from interface: TDoubleShortMap

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

Specified by:

containsKey in interface TDoubleShortMap

containsValue

public boolean containsValue(short val)

Description copied from interface: TDoubleShortMap

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

Specified by:

containsValue in interface TDoubleShortMap

get

public short get(double key)

Description copied from interface: TDoubleShortMap

Retrieves the value for key.

Specified by:

get in interface TDoubleShortMap

Returns:

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

put

public short put(double key,
                 short value)

Description copied from interface: TDoubleShortMap

Inserts a key/value pair into the map.

Specified by:

put in interface TDoubleShortMap

Returns:

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

remove

public short remove(double key)

Description copied from interface: TDoubleShortMap

Deletes a key/value pair from the map.

Specified by:

remove in interface TDoubleShortMap

Parameters:

key - an double value

Returns:

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

putAll

public void putAll(TDoubleShortMap m)

Description copied from interface: TDoubleShortMap

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

Specified by:

putAll in interface TDoubleShortMap

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.Double,? extends java.lang.Short> map)

Description copied from interface: TDoubleShortMap

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

Specified by:

putAll in interface TDoubleShortMap

Parameters:

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

clear

public void clear()

Description copied from interface: TDoubleShortMap

Empties the map.

Specified by:

clear in interface TDoubleShortMap

keySet

public TDoubleSet keySet()

Description copied from interface: TDoubleShortMap

Returns the keys of the map as a TDoubleSet

Specified by:

keySet in interface TDoubleShortMap

Returns:

the keys of the map as a TDoubleSet

keys

public double[] keys()

Description copied from interface: TDoubleShortMap

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

Specified by:

keys in interface TDoubleShortMap

Returns:

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

keys

public double[] keys(double[] array)

Description copied from interface: TDoubleShortMap

Returns the keys of the map.

Specified by:

keys in interface TDoubleShortMap

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: TDoubleShortMap

Returns the values of the map as a TShortCollection

Specified by:

valueCollection in interface TDoubleShortMap

Returns:

the values of the map as a TShortCollection

values

public short[] values()

Description copied from interface: TDoubleShortMap

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

Specified by:

values in interface TDoubleShortMap

Returns:

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

values

public short[] values(short[] array)

Description copied from interface: TDoubleShortMap

Returns the values of the map using an existing array.

Specified by:

values in interface TDoubleShortMap

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

getNoEntryKey

public double getNoEntryKey()

Description copied from interface: TDoubleShortMap

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

Returns:

the value that represents a null key in this collection.

getNoEntryValue

public short getNoEntryValue()

Description copied from interface: TDoubleShortMap

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

Returns:

the value that represents a null value in this collection.

forEachKey

public boolean forEachKey(TDoubleProcedure procedure)

Description copied from interface: TDoubleShortMap

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TDoubleShortMap

Parameters:

procedure - a TDoubleProcedure 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: TDoubleShortMap

Executes procedure for each value in the map.

Specified by:

forEachValue in interface TDoubleShortMap

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

Description copied from interface: TDoubleShortMap

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

Specified by:

forEachEntry in interface TDoubleShortMap

Parameters:

procedure - a TODoubleShortProcedure value

Returns:

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

iterator

public TDoubleShortIterator iterator()

Specified by:

iterator in interface TDoubleShortMap

Returns:

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

putIfAbsent

public short putIfAbsent(double key,
                         short value)

Description copied from interface: TDoubleShortMap

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

Specified by:

putIfAbsent in interface TDoubleShortMap

Returns:

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

transformValues

public void transformValues(TShortFunction function)

Description copied from interface: TDoubleShortMap

Transform the values in this map using function.

Specified by:

transformValues in interface TDoubleShortMap

Parameters:

function - a TShortFunction value

retainEntries

public boolean retainEntries(TDoubleShortProcedure procedure)

Description copied from interface: TDoubleShortMap

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

Specified by:

retainEntries in interface TDoubleShortMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

increment

public boolean increment(double key)

Description copied from interface: TDoubleShortMap

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TDoubleShortMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

public boolean adjustValue(double key,
                           short amount)

Description copied from interface: TDoubleShortMap

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TDoubleShortMap

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

Description copied from interface: TDoubleShortMap

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 TDoubleShortMap

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