Package 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 gnu.trove.impl.hash.TByteCharHash implements TByteCharMap, java.io.Externalizable
An open addressed Map implementation for byte keys and char values.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
TByteCharHashMap.TKeyView
a view onto the keys of the map.protected class
TByteCharHashMap.TValueView
a view onto the values of the map.
-
Field Summary
Fields Modifier and Type Field Description protected char[]
_values
the values of the map
-
Constructor Summary
Constructors Constructor Description TByteCharHashMap()
Creates a newTByteCharHashMap
instance with the default capacity and load factor.TByteCharHashMap(byte[] keys, char[] values)
Creates a newTByteCharHashMap
instance containing all of the entries in the map passed in.TByteCharHashMap(int initialCapacity)
Creates a newTByteCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.TByteCharHashMap(int initialCapacity, float loadFactor)
Creates a newTByteCharHashMap
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 newTByteCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TByteCharHashMap(TByteCharMap map)
Creates a newTByteCharHashMap
instance containing all of the entries in the map passed in.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 keyint
hashCode()
boolean
increment(byte key)
Increments the primitive value mapped to key by 1boolean
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 TByteSetchar
put(byte key, char value)
Inserts a key/value pair into the map.void
putAll(TByteCharMap map)
Put all the entries from the given map into this 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.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)
protected void
rehash(int newCapacity)
Rehashes the set.char
remove(byte key)
Deletes a key/value pair from the map.protected void
removeAt(int index)
Releases the element currently stored at index.boolean
retainEntries(TByteCharProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.protected int
setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.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 TCharCollectionchar[]
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, index, insertKey, XinsertKey
-
Methods inherited from class gnu.trove.impl.hash.THash
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface gnu.trove.map.TByteCharMap
getNoEntryKey, getNoEntryValue, size
-
-
-
-
Constructor Detail
-
TByteCharHashMap
public TByteCharHashMap()
Creates a newTByteCharHashMap
instance with the default capacity and load factor.
-
TByteCharHashMap
public TByteCharHashMap(int initialCapacity)
Creates a newTByteCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.- Parameters:
initialCapacity
- anint
value
-
TByteCharHashMap
public TByteCharHashMap(int initialCapacity, float loadFactor)
Creates a newTByteCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
value
-
TByteCharHashMap
public TByteCharHashMap(int initialCapacity, float loadFactor, byte noEntryKey, char noEntryValue)
Creates a newTByteCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
valuenoEntryKey
- abyte
value that represents null for the Key set.noEntryValue
- achar
value that represents null for the Value set.
-
TByteCharHashMap
public TByteCharHashMap(byte[] keys, char[] values)
Creates a newTByteCharHashMap
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 newTByteCharHashMap
instance containing all of the entries in the map passed in.- Parameters:
map
- a TByteCharMap that will be duplicated.
-
-
Method Detail
-
setUp
protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.- Overrides:
setUp
in classgnu.trove.impl.hash.TByteCharHash
- Parameters:
initialCapacity
- anint
value- Returns:
- the actual capacity chosen
-
rehash
protected void rehash(int newCapacity)
Rehashes the set.- Specified by:
rehash
in classgnu.trove.impl.hash.THash
- Parameters:
newCapacity
- anint
value
-
put
public char put(byte key, char value)
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTByteCharMap
- Parameters:
key
- anbyte
valuevalue
- anchar
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 interfaceTByteCharMap
- Parameters:
key
- anbyte
valuevalue
- anchar
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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- Parameters:
key
- anbyte
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 interfaceTByteCharMap
- Overrides:
clear
in classgnu.trove.impl.hash.THash
-
isEmpty
public boolean isEmpty()
Tells whether this set is currently holding any elements.- Specified by:
isEmpty
in interfaceTByteCharMap
- Overrides:
isEmpty
in classgnu.trove.impl.hash.THash
- Returns:
- a
boolean
value
-
remove
public char remove(byte key)
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTByteCharMap
- Parameters:
key
- anbyte
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TByteCharMap.getNoEntryValue()
).
-
removeAt
protected void removeAt(int index)
Releases the element currently stored at index.- Overrides:
removeAt
in classgnu.trove.impl.hash.TByteCharHash
- Parameters:
index
- anint
value
-
keySet
public TByteSet keySet()
Returns the keys of the map as a TByteSet- Specified by:
keySet
in interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- Parameters:
val
- anchar
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 interfaceTByteCharMap
- Parameters:
key
- anbyte
value- Returns:
- a
boolean
value
-
iterator
public TByteCharIterator iterator()
- Specified by:
iterator
in interfaceTByteCharMap
- 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 interfaceTByteCharMap
- Parameters:
procedure
- aTByteProcedure
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 interfaceTByteCharMap
- Parameters:
procedure
- aT#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 interfaceTByteCharMap
- Parameters:
procedure
- aTOByteCharProcedure
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 interfaceTByteCharMap
- Parameters:
function
- aTCharFunction
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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- 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 interfaceTByteCharMap
- Parameters:
key
- the key of the value to incrementamount
- 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 interfaceTByteCharMap
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to adjust the value byput_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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Overrides:
writeExternal
in classgnu.trove.impl.hash.TByteCharHash
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Overrides:
readExternal
in classgnu.trove.impl.hash.TByteCharHash
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-