gnu.trove.map.hash

Class TByteCharHashMap

java.lang.Object

gnu.trove.impl.hash.THash

gnu.trove.impl.hash.TPrimitiveHash

gnu.trove.impl.hash.TByteCharHash

gnu.trove.map.hash.TByteCharHashMap

All Implemented Interfaces:

TByteCharMap, java.io.Externalizable, java.io.Serializable

public class TByteCharHashMap
extends TByteCharHash
implements TByteCharMap, java.io.Externalizable

An open addressed Map implementation for byte keys and char values.

See Also:

Serialized Form

Field Summary

Fields inherited from class gnu.trove.impl.hash.TByteCharHash

_set

Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash

_states, FREE, FULL, REMOVED

Constructor Summary

Constructors

Constructor and Description
TByteCharHashMap() Creates a new TByteCharHashMap instance with the default capacity and load factor.
TByteCharHashMap(byte[] keys, char[] values) Creates a new TByteCharHashMap instance containing all of the entries in the map passed in.
TByteCharHashMap(int initialCapacity) Creates a new TByteCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TByteCharHashMap(int initialCapacity, float loadFactor) Creates a new TByteCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TByteCharHashMap(int initialCapacity, float loadFactor, byte noEntryKey, char noEntryValue) Creates a new TByteCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TByteCharHashMap(TByteCharMap map) Creates a new TByteCharHashMap instance containing all of the entries in the map passed in.

Method Summary

Modifier and Type	Method and Description
char	adjustOrPutValue(byte 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(byte key, char amount) Adjusts the primitive value mapped to key.
void	clear() Empties the collection.
boolean	containsKey(byte 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	equals(java.lang.Object other)
boolean	forEachEntry(TByteCharProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TByteProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TCharProcedure procedure) Executes procedure for each value in the map.
char	get(byte key) Retrieves the value for key
int	hashCode()
boolean	increment(byte key) Increments the primitive value mapped to key by 1
boolean	isEmpty() Tells whether this set is currently holding any elements.
TByteCharIterator	iterator()
byte[]	keys() Returns the keys of the map as an array of byte values.
byte[]	keys(byte[] array) Returns the keys of the map.
TByteSet	keySet() Returns the keys of the map as a TByteSet
char	put(byte key, char value) Inserts a key/value pair into the map.
void	putAll(java.util.Map<? extends java.lang.Byte,? extends java.lang.Character> map) Put all the entries from the given Map into this map.
void	putAll(TByteCharMap map) Put all the entries from the given map into this map.
char	putIfAbsent(byte key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.
void	readExternal(java.io.ObjectInput in)
char	remove(byte key) Deletes a key/value pair from the map.
boolean	retainEntries(TByteCharProcedure procedure) Retains only those entries in the map for which the procedure returns a true value.
java.lang.String	toString()
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class gnu.trove.impl.hash.TByteCharHash

contains, forEach, getNoEntryKey, getNoEntryValue

Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.impl.hash.THash

compact, ensureCapacity, getAutoCompactionFactor, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gnu.trove.map.TByteCharMap

getNoEntryKey, getNoEntryValue, size

Constructor Detail

TByteCharHashMap

public TByteCharHashMap()

Creates a new TByteCharHashMap instance with the default capacity and load factor.

TByteCharHashMap

public TByteCharHashMap(int initialCapacity)

Creates a new TByteCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

Parameters:

initialCapacity - an int value

TByteCharHashMap

public TByteCharHashMap(int initialCapacity,
                        float loadFactor)

Creates a new TByteCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters:

initialCapacity - an int value

loadFactor - a float value

TByteCharHashMap

public TByteCharHashMap(int initialCapacity,
                        float loadFactor,
                        byte noEntryKey,
                        char noEntryValue)

Creates a new TByteCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters:

initialCapacity - an int value

loadFactor - a float value

noEntryKey - a byte value that represents null for the Key set.

noEntryValue - a char value that represents null for the Value set.

TByteCharHashMap

public TByteCharHashMap(byte[] keys,
                        char[] values)

Creates a new TByteCharHashMap instance containing all of the entries in the map passed in.

Parameters:

keys - a byte array containing the keys for the matching values.

values - a char array containing the values.

TByteCharHashMap

public TByteCharHashMap(TByteCharMap map)

Creates a new TByteCharHashMap instance containing all of the entries in the map passed in.

Parameters:

map - a TByteCharMap that will be duplicated.

Method Detail

put

public char put(byte key,
                char value)

Inserts a key/value pair into the map.

Specified by:

put in interface TByteCharMap

Parameters:

key - an byte value

value - an char value

Returns:

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

putIfAbsent

public char putIfAbsent(byte key,
                        char value)

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

Specified by:

putIfAbsent in interface TByteCharMap

Parameters:

key - an byte value

value - an char value

Returns:

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

putAll

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

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

Specified by:

putAll in interface TByteCharMap

Parameters:

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

putAll

public void putAll(TByteCharMap map)

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

Specified by:

putAll in interface TByteCharMap

Parameters:

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

get

public char get(byte key)

Retrieves the value for key

Specified by:

get in interface TByteCharMap

Parameters:

key - an byte value

Returns:

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

clear

public void clear()

Empties the collection.

Specified by:

clear in interface TByteCharMap

Overrides:

clear in class THash

isEmpty

public boolean isEmpty()

Tells whether this set is currently holding any elements.

Specified by:

isEmpty in interface TByteCharMap

Overrides:

isEmpty in class THash

Returns:

a boolean value

remove

public char remove(byte key)

Deletes a key/value pair from the map.

Specified by:

remove in interface TByteCharMap

Parameters:

key - an byte value

Returns:

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

keySet

public TByteSet keySet()

Returns the keys of the map as a TByteSet

Specified by:

keySet in interface TByteCharMap

Returns:

the keys of the map as a TByteSet

keys

public byte[] keys()

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

Specified by:

keys in interface TByteCharMap

Returns:

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

keys

public byte[] keys(byte[] array)

Returns the keys of the map.

Specified by:

keys in interface TByteCharMap

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

Returns the values of the map as a TCharCollection

Specified by:

valueCollection in interface TByteCharMap

Returns:

the values of the map as a TCharCollection

values

public char[] values()

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

Specified by:

values in interface TByteCharMap

Returns:

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

values

public char[] values(char[] array)

Returns the values of the map using an existing array.

Specified by:

values in interface TByteCharMap

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

public boolean containsValue(char val)

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

Specified by:

containsValue in interface TByteCharMap

Parameters:

val - an char value

Returns:

a boolean value

containsKey

public boolean containsKey(byte key)

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

Specified by:

containsKey in interface TByteCharMap

Parameters:

key - an byte value

Returns:

a boolean value

iterator

public TByteCharIterator iterator()

Specified by:

iterator in interface TByteCharMap

Returns:

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

forEachKey

public boolean forEachKey(TByteProcedure procedure)

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TByteCharMap

Parameters:

procedure - a TByteProcedure value

Returns:

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

forEachValue

public boolean forEachValue(TCharProcedure procedure)

Executes procedure for each value in the map.

Specified by:

forEachValue in interface TByteCharMap

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

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

Specified by:

forEachEntry in interface TByteCharMap

Parameters:

procedure - a TOByteCharProcedure value

Returns:

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

transformValues

public void transformValues(TCharFunction function)

Transform the values in this map using function.

Specified by:

transformValues in interface TByteCharMap

Parameters:

function - a TCharFunction value

retainEntries

public boolean retainEntries(TByteCharProcedure procedure)

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

Specified by:

retainEntries in interface TByteCharMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

increment

public boolean increment(byte key)

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TByteCharMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

public boolean adjustValue(byte key,
                           char amount)

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TByteCharMap

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 char adjustOrPutValue(byte 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.

Specified by:

adjustOrPutValue in interface TByteCharMap

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

equals

public boolean equals(java.lang.Object other)

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

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class TByteCharHash

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class TByteCharHash

Throws:

java.io.IOException

java.lang.ClassNotFoundException