TObjectCharHashMap

java.lang.Object
- com.slimjars.dist.gnu.trove.impl.hash.THash
- - com.slimjars.dist.gnu.trove.impl.hash.TObjectHash<K>
  - - com.slimjars.dist.gnu.trove.map.hash.TObjectCharHashMap<K>

All Implemented Interfaces:

TObjectCharMap<K>, Externalizable, Serializable
```
public class TObjectCharHashMap<K>
extends TObjectHash<K>
implements TObjectCharMap<K>, Externalizable
```
An open addressed Map implementation for Object keys and char values. Created: Sun Nov 4 08:52:45 2001

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`protected class`	`TObjectCharHashMap.KeyView` a view onto the keys of the map.

Field Summary

Fields

Modifier and Type	Field and Description
`protected char[]`	`_values` the values of the map
`protected char`	`no_entry_value` the value that represents null

Fields inherited from class com.slimjars.dist.gnu.trove.impl.hash.TObjectHash
_set, consumeFreeSlot, FREE, REMOVED

Fields inherited from class com.slimjars.dist.gnu.trove.impl.hash.THash
_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

Constructors

Constructor and Description
`TObjectCharHashMap()` Creates a new `TObjectCharHashMap` instance with the default capacity and load factor.
`TObjectCharHashMap(int initialCapacity)` Creates a new `TObjectCharHashMap` instance with a prime capacity equal to or greater than `initialCapacity` and with the default load factor.
`TObjectCharHashMap(int initialCapacity, float loadFactor)` Creates a new `TObjectCharHashMap` instance with a prime capacity equal to or greater than `initialCapacity` and with the specified load factor.
`TObjectCharHashMap(int initialCapacity, float loadFactor, char noEntryValue)` Creates a new `TObjectCharHashMap` instance with a prime value at or near the specified capacity and load factor.
`TObjectCharHashMap(TObjectCharMap<? extends K> map)` Creates a new `TObjectCharHashMap` that contains the entries in the map passed to it.

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`char`	`adjustOrPutValue(K key, char adjust_amount, char put_amount)`
`boolean`	`adjustValue(K key, char amount)`
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(char val)`
`boolean`	`equals(Object other)` Compares this map with another map for equality of their stored entries.
`boolean`	`forEachEntry(TObjectCharProcedure<? super K> procedure)` Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TObjectProcedure<? super K> procedure)` Executes `procedure` for each key in the map.
`boolean`	`forEachValue(TCharProcedure procedure)` Executes `procedure` for each value in the map.
`char`	`get(Object key)`
`char`	`getNoEntryValue()`
`int`	`hashCode()`
`boolean`	`increment(K key)`
`TObjectCharIterator<K>`	`iterator()`
`Object[]`	`keys()`
`K[]`	`keys(K[] a)`
`Set<K>`	`keySet()`
`char`	`put(K key, char value)`
`void`	`putAll(Map<? extends K,? extends Character> map)`
`void`	`putAll(TObjectCharMap<? extends K> map)`
`char`	`putIfAbsent(K key, char value)`
`void`	`readExternal(ObjectInput in)`
`protected void`	`rehash(int newCapacity)` rehashes the map to the new capacity.
`char`	`remove(Object key)`
`protected void`	`removeAt(int index)` Removes the mapping at `index` from the map.
`boolean`	`retainEntries(TObjectCharProcedure<? super K> procedure)` Retains only those entries in the map for which the procedure returns a true value.
`int`	`setUp(int initialCapacity)` initializes the hashtable to a prime capacity which is at least `initialCapacity + 1`.
`String`	`toString()`
`void`	`transformValues(TCharFunction function)` Transform the values in this map using `function`.
`TCharCollection`	`valueCollection()`
`char[]`	`values()`
`char[]`	`values(char[] array)`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class com.slimjars.dist.gnu.trove.impl.hash.TObjectHash
buildObjectContractViolation, capacity, contains, dumpExtraInfo, equals, forEach, hash, index, insertionIndex, insertKey, objectInfo, reportPotentialConcurrentMod, throwObjectContractViolation, throwObjectContractViolation

Methods inherited from class com.slimjars.dist.gnu.trove.impl.hash.THash
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, isEmpty, 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 com.slimjars.dist.gnu.trove.map.TObjectCharMap
isEmpty, size

- Field Detail
  - _values
```
protected transient char[] _values
```
    the values of the map
  - no_entry_value
```
protected char no_entry_value
```
    the value that represents null
- Constructor Detail
  - TObjectCharHashMap
```
public TObjectCharHashMap()
```
    Creates a new TObjectCharHashMap instance with the default capacity and load factor.
  - TObjectCharHashMap
```
public TObjectCharHashMap(int initialCapacity)
```
    Creates a new TObjectCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    
    Parameters:
    
    initialCapacity - an int value
  - TObjectCharHashMap
```
public TObjectCharHashMap(int initialCapacity,
                          float loadFactor)
```
    Creates a new TObjectCharHashMap 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
  - TObjectCharHashMap
```
public TObjectCharHashMap(int initialCapacity,
                          float loadFactor,
                          char noEntryValue)
```
    Creates a new TObjectCharHashMap instance with a prime value at or near the specified capacity and load factor.
    
    Parameters:
    
    initialCapacity - used to find a prime capacity for the table.
    
    loadFactor - used to calculate the threshold over which rehashing takes place.
    
    noEntryValue - the value used to represent null.
  - TObjectCharHashMap
```
public TObjectCharHashMap(TObjectCharMap<? extends K> map)
```
    Creates a new TObjectCharHashMap that contains the entries in the map passed to it.
    
    Parameters:
    
    map - the TObjectCharMap to be copied.
- Method Detail
  - setUp
```
public int setUp(int initialCapacity)
```
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    
    Overrides:
    
    setUp in class TObjectHash<K>
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - rehash
```
protected void rehash(int newCapacity)
```
    rehashes the map to the new capacity.
    
    Specified by:
    
    rehash in class THash
    
    Parameters:
    
    newCapacity - an int value
  - getNoEntryValue
```
public char getNoEntryValue()
```
  - containsKey
```
public boolean containsKey(Object key)
```
  - containsValue
```
public boolean containsValue(char val)
```
  - get
```
public char get(Object key)
```
  - put
```
public char put(K key,
                char value)
```
  - putIfAbsent
```
public char putIfAbsent(K key,
                        char value)
```
  - remove
```
public char remove(Object key)
```
  - removeAt
```
protected void removeAt(int index)
```
    Removes the mapping at index from the map. This method is used internally and public mainly because of packaging reasons. Caveat Programmer.
    
    Overrides:
    
    removeAt in class TObjectHash<K>
    
    Parameters:
    
    index - an int value
  - putAll
```
public void putAll(Map<? extends K,? extends Character> map)
```
  - putAll
```
public void putAll(TObjectCharMap<? extends K> map)
```
  - clear
```
public void clear()
```
  - keySet
```
public Set<K> keySet()
```
  - keys
```
public Object[] keys()
```
  - keys
```
public K[] keys(K[] a)
```
  - valueCollection
```
public TCharCollection valueCollection()
```
  - values
```
public char[] values()
```
  - values
```
public char[] values(char[] array)
```
  - iterator
```
public TObjectCharIterator<K> iterator()
```
    Specified by:
    
    iterator in interface TObjectCharMap<K>
    
    Returns:
    
    an iterator over the entries in this map
  - increment
```
public boolean increment(K key)
```
  - adjustValue
```
public boolean adjustValue(K key,
                           char amount)
```
  - adjustOrPutValue
```
public char adjustOrPutValue(K key,
                             char adjust_amount,
                             char put_amount)
```
  - forEachKey
```
public boolean forEachKey(TObjectProcedure<? super K> procedure)
```
    Executes procedure for each key in the map.
    
    Specified by:
    
    forEachKey in interface TObjectCharMap<K>
    
    Parameters:
    
    procedure - a TObjectProcedure 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 TObjectCharMap<K>
    
    Parameters:
    
    procedure - a TCharProcedure value
    
    Returns:
    
    false if the loop over the values terminated because the procedure returned false for some value.
  - forEachEntry
```
public boolean forEachEntry(TObjectCharProcedure<? super K> procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Specified by:
    
    forEachEntry in interface TObjectCharMap<K>
    
    Parameters:
    
    procedure - a TOObjectCharProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - retainEntries
```
public boolean retainEntries(TObjectCharProcedure<? super K> procedure)
```
    Retains only those entries in the map for which the procedure returns a true value.
    
    Specified by:
    
    retainEntries in interface TObjectCharMap<K>
    
    Parameters:
    
    procedure - determines which entries to keep
    
    Returns:
    
    true if the map was modified.
  - transformValues
```
public void transformValues(TCharFunction function)
```
    Transform the values in this map using function.
    
    Specified by:
    
    transformValues in interface TObjectCharMap<K>
    
    Parameters:
    
    function - a TCharFunction value
  - equals
```
public boolean equals(Object other)
```
    Compares this map with another map for equality of their stored entries.
    
    Specified by:
    
    equals in interface TObjectCharMap<K>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - an Object value
    
    Returns:
    
    a boolean value
  - hashCode
```
public int hashCode()
```
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Overrides:
    
    writeExternal in class TObjectHash<K>
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Overrides:
    
    readExternal in class TObjectHash<K>
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - toString
```
public String toString()
```

Class TObjectCharHashMap<K>

Nested Class Summary

Nested Classes

Field Summary

Fields

Fields inherited from class com.slimjars.dist.gnu.trove.impl.hash.TObjectHash

Fields inherited from class com.slimjars.dist.gnu.trove.impl.hash.THash

Constructor Summary

Constructors

Method Summary

Methods inherited from class com.slimjars.dist.gnu.trove.impl.hash.TObjectHash

Methods inherited from class com.slimjars.dist.gnu.trove.impl.hash.THash

Methods inherited from class java.lang.Object

Methods inherited from interface com.slimjars.dist.gnu.trove.map.TObjectCharMap

Field Detail

_values

no_entry_value

Constructor Detail

TObjectCharHashMap

TObjectCharHashMap

TObjectCharHashMap

TObjectCharHashMap

TObjectCharHashMap

Method Detail

setUp

rehash

getNoEntryValue

containsKey

containsValue

get

put

putIfAbsent

remove

removeAt

putAll

putAll

clear

keySet

keys

keys

valueCollection

values

values

iterator

increment

adjustValue

adjustOrPutValue

forEachKey

forEachValue

forEachEntry

retainEntries

transformValues

equals

hashCode

writeExternal

readExternal

toString