|
GNU Trove | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object gnu.trove.impl.hash.THash gnu.trove.impl.hash.TPrimitiveHash gnu.trove.impl.hash.TShortHash gnu.trove.map.hash.TShortObjectHashMap<V>
public class TShortObjectHashMap<V>
An open addressed Map implementation for short keys and Object values. Created: Sun Nov 4 08:52:45 2001
Nested Class Summary | |
---|---|
protected class |
TShortObjectHashMap.ValueView
a view onto the values of the map. |
Field Summary | |
---|---|
protected V[] |
_values
the values of the map |
protected short |
no_entry_key
the value that represents null in the key set. |
Fields inherited from class gnu.trove.impl.hash.TShortHash |
---|
_set, consumeFreeSlot, no_entry_value |
Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash |
---|
_states, FREE, FULL, REMOVED |
Fields inherited from class gnu.trove.impl.hash.THash |
---|
_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR |
Constructor Summary | |
---|---|
TShortObjectHashMap()
Creates a new TShortObjectHashMap instance with the default
capacity and load factor. |
|
TShortObjectHashMap(int initialCapacity)
Creates a new TShortObjectHashMap instance with a prime
capacity equal to or greater than initialCapacity and
with the default load factor. |
|
TShortObjectHashMap(int initialCapacity,
float loadFactor)
Creates a new TShortObjectHashMap instance with a prime
capacity equal to or greater than initialCapacity and
with the specified load factor. |
|
TShortObjectHashMap(int initialCapacity,
float loadFactor,
short noEntryKey)
Creates a new TShortObjectHashMap instance with a prime
value at or near the specified capacity and load factor. |
|
TShortObjectHashMap(TShortObjectMap<? extends V> map)
Creates a new TShortObjectHashMap that contains the entries
in the map passed to it. |
Method Summary | |
---|---|
void |
clear()
Empties the collection. |
boolean |
containsKey(short key)
Returns true if this map contains a mapping for the specified key. |
boolean |
containsValue(java.lang.Object val)
Returns true if this map maps one or more keys to the specified value. |
boolean |
equals(java.lang.Object other)
Compares the specified object with this map for equality. |
boolean |
forEachEntry(TShortObjectProcedure<? super V> 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(TObjectProcedure<? super V> procedure)
Executes procedure for each value in the map. |
V |
get(short key)
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. |
short |
getNoEntryKey()
Returns the value that represents null in the TShortObjectMap.keySet() . |
int |
hashCode()
Returns the hash code value for this map. |
TShortObjectIterator<V> |
iterator()
Returns a TShortObjectIterator with access to this map's keys and values. |
short[] |
keys()
Returns a copy of the keys of the map as an array. |
short[] |
keys(short[] dest)
Returns a copy of the keys of the map as an array. |
TShortSet |
keySet()
Returns a TShortSet view of the keys contained in this map. |
V |
put(short key,
V value)
Associates the specified value with the specified key in this map (optional operation). |
void |
putAll(java.util.Map<? extends java.lang.Short,? extends V> map)
Copies all of the mappings from the specified map to this map (optional operation). |
void |
putAll(TShortObjectMap<? extends V> map)
Put all the entries from the given map into this map. |
V |
putIfAbsent(short key,
V 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. |
V |
remove(short key)
Removes the mapping for a key from this map if it is present (optional operation). |
protected void |
removeAt(int index)
Releases the element currently stored at index. |
boolean |
retainEntries(TShortObjectProcedure<? super V> 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(TObjectFunction<V,V> function)
Transform the values in this map using function. |
java.util.Collection<V> |
valueCollection()
Returns a Collection view of the values contained in this map. |
V[] |
values()
Returns the values of the map as an array of short values. |
V[] |
values(V[] dest)
Returns the values of the map using an existing array. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class gnu.trove.impl.hash.TShortHash |
---|
contains, forEach, getNoEntryValue, index, insertKey |
Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash |
---|
capacity |
Methods inherited from class 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 gnu.trove.map.TShortObjectMap |
---|
isEmpty, size |
Field Detail |
---|
protected transient V[] _values
protected short no_entry_key
Constructor Detail |
---|
public TShortObjectHashMap()
TShortObjectHashMap
instance with the default
capacity and load factor.
public TShortObjectHashMap(int initialCapacity)
TShortObjectHashMap
instance with a prime
capacity equal to or greater than initialCapacity and
with the default load factor.
initialCapacity
- an int
valuepublic TShortObjectHashMap(int initialCapacity, float loadFactor)
TShortObjectHashMap
instance with a prime
capacity equal to or greater than initialCapacity and
with the specified load factor.
initialCapacity
- an int
valueloadFactor
- a float
valuepublic TShortObjectHashMap(int initialCapacity, float loadFactor, short noEntryKey)
TShortObjectHashMap
instance with a prime
value at or near the specified capacity and load factor.
initialCapacity
- used to find a prime capacity for the table.loadFactor
- used to calculate the threshold over which
rehashing takes place.noEntryKey
- the value used to represent null in the key set.public TShortObjectHashMap(TShortObjectMap<? extends V> map)
TShortObjectHashMap
that contains the entries
in the map passed to it.
map
- the TShortObjectMap to be copied.Method Detail |
---|
protected int setUp(int initialCapacity)
setUp
in class gnu.trove.impl.hash.TShortHash
initialCapacity
- an int
value
protected void rehash(int newCapacity)
rehash
in class gnu.trove.impl.hash.THash
newCapacity
- an int
valuepublic short getNoEntryKey()
TShortObjectMap.keySet()
.
The default value is generally zero, but can be changed during
construction of the collection.
getNoEntryKey
in interface TShortObjectMap<V>
public boolean containsKey(short key)
containsKey
in interface TShortObjectMap<V>
key
- key whose presence in this map is to be tested
public boolean containsValue(java.lang.Object val)
containsValue
in interface TShortObjectMap<V>
val
- value whose presence in this map is to be tested
public V get(short key)
null
if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
k
to a value v
such that (key==null ? k==null :
key.equals(k))
, then this method returns v
; otherwise
it returns null
. (There can be at most one such mapping.)
If this map permits null values, then a return value of
null
does not necessarily indicate that the map
contains no mapping for the key; it's also possible that the map
explicitly maps the key to null
. The containsKey
operation may be used to distinguish these two cases.
get
in interface TShortObjectMap<V>
key
- the key whose associated value is to be returned
null
if this map contains no mapping for the keypublic V put(short key, V value)
m.containsKey(k)
would return
true.)
put
in interface TShortObjectMap<V>
key
- key with which the specified value is to be associatedvalue
- an short value value to be associated with the specified key
TShortObjectMap.getNoEntryKey()
public V putIfAbsent(short key, V value)
putIfAbsent
in interface TShortObjectMap<V>
key
- key with which the specified value is to be associatedvalue
- an short value to be associated with the specified key
public V remove(short key)
key.equals(k)
, that mapping
is removed. (The map can contain at most one such mapping.)
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.
The map will not contain a mapping for the specified key once the call returns.
remove
in interface TShortObjectMap<V>
key
- key whose mapping is to be removed from the map
protected void removeAt(int index)
removeAt
in class gnu.trove.impl.hash.TShortHash
index
- an int
valuepublic void putAll(java.util.Map<? extends java.lang.Short,? extends V> map)
put(k, v)
on this map once
for each mapping from key k to value v in the
specified map. The behavior of this operation is undefined if the
specified map is modified while the operation is in progress.
putAll
in interface TShortObjectMap<V>
map
- mappings to be stored in this mappublic void putAll(TShortObjectMap<? extends V> map)
putAll
in interface TShortObjectMap<V>
map
- The map from which entries will be obtained to put into this map.public void clear()
clear
in interface TShortObjectMap<V>
clear
in class gnu.trove.impl.hash.THash
public TShortSet keySet()
TShortSet
view of the keys contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.
keySet
in interface TShortObjectMap<V>
public short[] keys()
keys
in interface TShortObjectMap<V>
public short[] keys(short[] dest)
keys
in interface TShortObjectMap<V>
dest
- 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.
public java.util.Collection<V> valueCollection()
Collection
view of the values contained in this map.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.
valueCollection
in interface TShortObjectMap<V>
public V[] values()
values
in interface TShortObjectMap<V>
public V[] values(V[] dest)
values
in interface TShortObjectMap<V>
dest
- 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.
public TShortObjectIterator<V> iterator()
iterator
in interface TShortObjectMap<V>
public boolean forEachKey(TShortProcedure procedure)
forEachKey
in interface TShortObjectMap<V>
procedure
- a TObjectProcedure
value
public boolean forEachValue(TObjectProcedure<? super V> procedure)
forEachValue
in interface TShortObjectMap<V>
procedure
- a TObjectProcedure
value
public boolean forEachEntry(TShortObjectProcedure<? super V> procedure)
forEachEntry
in interface TShortObjectMap<V>
procedure
- a TShortObjectProcedure
value
public boolean retainEntries(TShortObjectProcedure<? super V> procedure)
retainEntries
in interface TShortObjectMap<V>
procedure
- determines which entries to keep
public void transformValues(TObjectFunction<V,V> function)
transformValues
in interface TShortObjectMap<V>
function
- a TObjectFunction
valuepublic boolean equals(java.lang.Object other)
equals
in interface TShortObjectMap<V>
equals
in class java.lang.Object
other
- object to be compared for equality with this map
public int hashCode()
Object.hashCode()
.
hashCode
in interface TShortObjectMap<V>
hashCode
in class java.lang.Object
Object.equals(Object)
,
TShortObjectMap.equals(Object)
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
writeExternal
in class gnu.trove.impl.hash.THash
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
readExternal
in class gnu.trove.impl.hash.THash
java.io.IOException
java.lang.ClassNotFoundException
public java.lang.String toString()
toString
in class java.lang.Object
|
GNU Trove | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |