|
GNU Trove | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TLongObjectMap<V>
Interface for a primitive map of long keys and Object values.
Method Summary | |
---|---|
void |
clear()
Removes all of the mappings from this map (optional operation). |
boolean |
containsKey(long key)
Returns true if this map contains a mapping for the specified key. |
boolean |
containsValue(java.lang.Object value)
Returns true if this map maps one or more keys to the specified value. |
boolean |
equals(java.lang.Object o)
Compares the specified object with this map for equality. |
boolean |
forEachEntry(TLongObjectProcedure<? super V> procedure)
Executes procedure for each key/value entry in the map. |
boolean |
forEachKey(TLongProcedure 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(long key)
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. |
long |
getNoEntryKey()
Returns the value that represents null in the keySet() . |
int |
hashCode()
Returns the hash code value for this map. |
boolean |
isEmpty()
Returns true if this map contains no key-value mappings. |
TLongObjectIterator<V> |
iterator()
Returns a TLongObjectIterator with access to this map's keys and values. |
long[] |
keys()
Returns a copy of the keys of the map as an array. |
long[] |
keys(long[] array)
Returns a copy of the keys of the map as an array. |
TLongSet |
keySet()
Returns a TLongSet view of the keys contained in this map. |
V |
put(long key,
V value)
Associates the specified value with the specified key in this map (optional operation). |
void |
putAll(java.util.Map<? extends java.lang.Long,? extends V> m)
Copies all of the mappings from the specified map to this map (optional operation). |
void |
putAll(TLongObjectMap<? extends V> map)
Put all the entries from the given map into this map. |
V |
putIfAbsent(long key,
V value)
Inserts a key/value pair into the map if the specified key is not already associated with a value. |
V |
remove(long key)
Removes the mapping for a key from this map if it is present (optional operation). |
boolean |
retainEntries(TLongObjectProcedure<? super V> procedure)
Retains only those entries in the map for which the procedure returns a true value. |
int |
size()
Returns the number of key-value mappings in this map. |
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 long values. |
V[] |
values(V[] array)
Returns the values of the map using an existing array. |
Method Detail |
---|
long getNoEntryKey()
keySet()
.
The default value is generally zero, but can be changed during
construction of the collection.
int size()
boolean isEmpty()
boolean containsKey(long key)
key
- key whose presence in this map is to be tested
java.lang.ClassCastException
- if the key is of an inappropriate type for
this map (optional)
java.lang.NullPointerException
- if the specified key is null and this map
does not permit null keys (optional)boolean containsValue(java.lang.Object value)
value
- value whose presence in this map is to be tested
java.lang.ClassCastException
- if the value is of an inappropriate type for
this map (optional)
java.lang.NullPointerException
- if the specified value is null and this
map does not permit null values (optional)V get(long 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.
key
- the key whose associated value is to be returned
null
if this map contains no mapping for the key
java.lang.ClassCastException
- if the key is of an inappropriate type for
this map (optional)
java.lang.NullPointerException
- if the specified key is null and this map
does not permit null keys (optional)V put(long key, V value)
m.containsKey(k)
would return
true.)
key
- key with which the specified value is to be associatedvalue
- an long value value to be associated with the specified key
java.lang.UnsupportedOperationException
- if the put operation
is not supported by this map
java.lang.ClassCastException
- if the class of the specified key or value
prevents it from being stored in this map
java.lang.NullPointerException
- if the specified key or value is null
and this map does not permit null keys or values
java.lang.IllegalArgumentException
- if some property of the specified key
or value prevents it from being stored in this mapgetNoEntryKey()
V putIfAbsent(long key, V value)
key
- key with which the specified value is to be associatedvalue
- an long value to be associated with the specified key
V remove(long 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.
key
- key whose mapping is to be removed from the map
java.lang.UnsupportedOperationException
- if the remove operation
is not supported by this map
java.lang.ClassCastException
- if the key is of an inappropriate type for
this map (optional)
java.lang.NullPointerException
- if the specified key is null and this
map does not permit null keys (optional)void putAll(java.util.Map<? extends java.lang.Long,? extends V> m)
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.
m
- mappings to be stored in this map
java.lang.UnsupportedOperationException
- if the putAll operation
is not supported by this map
java.lang.ClassCastException
- if the class of a key or value in the
specified map prevents it from being stored in this map
java.lang.NullPointerException
- if the specified map is null, or if
this map does not permit null keys or values, and the
specified map contains null keys or values
java.lang.IllegalArgumentException
- if some property of a key or value in
the specified map prevents it from being stored in this mapvoid putAll(TLongObjectMap<? extends V> map)
map
- The map from which entries will be obtained to put into this map.void clear()
java.lang.UnsupportedOperationException
- if the clear operation
is not supported by this mapTLongSet keySet()
TLongSet
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.
long[] keys()
long[] keys(long[] array)
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.
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.
V[] values()
V[] values(V[] array)
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.
TLongObjectIterator<V> iterator()
boolean forEachKey(TLongProcedure procedure)
procedure
- a TObjectProcedure
value
boolean forEachValue(TObjectProcedure<? super V> procedure)
procedure
- a TObjectProcedure
value
boolean forEachEntry(TLongObjectProcedure<? super V> procedure)
procedure
- a TLongObjectProcedure
value
void transformValues(TObjectFunction<V,V> function)
function
- a TObjectFunction
valueboolean retainEntries(TLongObjectProcedure<? super V> procedure)
procedure
- determines which entries to keep
boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- object to be compared for equality with this map
int hashCode()
Object.hashCode()
.
hashCode
in class java.lang.Object
Object.equals(Object)
,
equals(Object)
|
GNU Trove | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |