gnu.trove.map
Interface TShortCharMap

All Known Implementing Classes:

TShortCharHashMap

public interface TShortCharMap

Interface for a primitive map of short keys and char values.

Method Summary

char	adjustOrPutValue(short key, char adjust_amount, char put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(short key, char 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(char val) Checks for the presence of val in the values of the map.
boolean	forEachEntry(TShortCharProcedure 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(TCharProcedure procedure) Executes procedure for each value in the map.
char	get(short key) Retrieves the value for key
short	getNoEntryKey() Returns the value that will be returned from get(short) or put(short, char) if no entry exists for a given key.
char	getNoEntryValue() Returns the value that will be returned from get(short) or put(short, char) if no entry exists for a given key.
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.
TShortCharIterator	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
char	put(short key, char value) Inserts a key/value pair into the map.
void	putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> map) Put all the entries from the given Map into this map.
void	putAll(TShortCharMap map) Put all the entries from the given map into this map.
char	putIfAbsent(short key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.
char	remove(short key) Deletes a key/value pair from the map.
boolean	retainEntries(TShortCharProcedure 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.
void	transformValues(TCharFunction function) Transform the values in this map using function.
TCharCollection	valueCollection() Returns the values of the map as a TCharCollection
char[]	values() Returns the values of the map as an array of #e# values.
char[]	values(char[] array) Returns the values of the map using an existing array.

Method Detail

getNoEntryKey

short getNoEntryKey()

Returns the value that will be returned from get(short) or put(short, char) if no entry exists for a given key. The default value is generally zero, but can be changed during construction of the collection.

Returns:

the value that represents a null key in this collection.

getNoEntryValue

char getNoEntryValue()

Returns the value that will be returned from get(short) or put(short, char) if no entry exists for a given key. The default value is generally zero, but can be changed during construction of the collection.

Returns:

the value that represents a null value in this collection.

put

char put(short key,
         char value)

Inserts a key/value pair into the map.

Parameters:

key - an short value

value - an char value

Returns:

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

putIfAbsent

char putIfAbsent(short key,
                 char value)

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

Parameters:

key - an short value

value - an char value

Returns:

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

putAll

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

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

Parameters:

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

putAll

void putAll(TShortCharMap map)

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

Parameters:

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

get

char get(short key)

Retrieves the value for key

Parameters:

key - an short value

Returns:

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

clear

void clear()

Empties the map.

isEmpty

boolean isEmpty()

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

Returns:

true if this map contains no key-value mappings

remove

char remove(short key)

Deletes a key/value pair from the map.

Parameters:

key - an short value

Returns:

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

size

int size()

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

Returns:

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

keySet

TShortSet keySet()

Returns the keys of the map as a TShortSet

Returns:

the keys of the map as a TShortSet

keys

short[] keys()

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

Returns:

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

keys

short[] keys(short[] array)

Returns the keys of the map.

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

TCharCollection valueCollection()

Returns the values of the map as a TCharCollection

Returns:

the values of the map as a TCharCollection

values

char[] values()

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

Returns:

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

values

char[] values(char[] array)

Returns the values of the map using an existing array.

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.

containsValue

boolean containsValue(char val)

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

Parameters:

val - an char value

Returns:

a boolean value

containsKey

boolean containsKey(short key)

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

Parameters:

key - an short value

Returns:

a boolean value

iterator

TShortCharIterator iterator()

Returns:

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

forEachKey

boolean forEachKey(TShortProcedure procedure)

Executes procedure for each key in the map.

Parameters:

procedure - a TShortProcedure value

Returns:

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

forEachValue

boolean forEachValue(TCharProcedure procedure)

Executes procedure for each value in the map.

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

boolean forEachEntry(TShortCharProcedure procedure)

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

Parameters:

procedure - a TOShortCharProcedure value

Returns:

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

transformValues

void transformValues(TCharFunction function)

Transform the values in this map using function.

Parameters:

function - a TCharFunction value

retainEntries

boolean retainEntries(TShortCharProcedure procedure)

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

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

increment

boolean increment(short key)

Increments the primitive value mapped to key by 1

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

boolean adjustValue(short key,
                    char amount)

Adjusts the primitive value mapped to key.

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

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

Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.

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

Returns:

the value present in the map after the adjustment or put operation