Class ConcurrentHashMap.KeySetView<K,V>
- All Implemented Interfaces:
-
Serializable
,Iterable<K>
,Collection<K>
,Set<K>
- Enclosing class:
-
ConcurrentHashMap<K,
V>
public static class ConcurrentHashMap.KeySetView<K,V> extends Object implements Set<K>, Serializable
Set
of keys, in which additions may optionally be enabled by mapping to a common value. This class cannot be directly instantiated. See keySet()
, keySet(V)
, newKeySet()
, newKeySet(int)
.- Since:
- 1.8
- See Also:
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean |
add |
Adds the specified key to this set view by mapping the key to the default mapped value in the backing map, if defined. |
boolean |
addAll |
Adds all of the elements in the specified collection to this set, as if by calling add(K) on each one. |
final void |
clear() |
Removes all of the elements from this view, by removing all the mappings from the map backing this view. |
boolean |
contains |
Returns true if this collection contains the specified element. |
final boolean |
containsAll |
Returns true if this collection contains all of the elements in the specified collection. |
boolean |
equals |
Indicates whether some other object is "equal to" this one. |
ConcurrentHashMap<K, |
getMap() |
Returns the map backing this view. |
V |
getMappedValue() |
Returns the default mapped value for additions, or null if additions are not supported. |
int |
hashCode() |
Returns a hash code value for the object. |
final boolean |
isEmpty() |
Returns true if this collection contains no elements. |
Iterator<K> |
iterator() |
Returns an iterator over the elements in this collection. |
boolean |
remove |
Removes the key from this map view, by removing the key (and its corresponding value) from the backing map. |
boolean |
removeAll |
Removes all of this collection's elements that are also contained in the specified collection (optional operation). |
final boolean |
retainAll |
Retains only the elements in this collection that are contained in the specified collection (optional operation). |
final int |
size() |
Returns the number of elements in this collection. |
final Object[] |
toArray() |
Returns an array containing all of the elements in this collection. |
final <T> T[] |
toArray |
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. |
final String |
toString() |
Returns a string representation of this collection. |
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods declared in interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods declared in interface java.util.Set
clear, containsAll, isEmpty, removeAll, retainAll, size, spliterator, toArray, toArray
Method Details
getMappedValue
public V getMappedValue()
null
if additions are not supported.- Returns:
- the default mapped value for additions, or
null
if not supported
contains
public boolean contains(Object o)
true
if this collection contains the specified element. More formally, returns true
if and only if this collection contains at least one element e
such that Objects.equals(o, e)
.- Specified by:
-
contains
in interfaceCollection<K>
- Specified by:
-
contains
in interfaceSet<K>
- Parameters:
-
o
- element whose presence in this collection is to be tested - Returns:
-
true
if this collection contains the specified element - Throws:
-
NullPointerException
- if the specified key is null
remove
public boolean remove(Object o)
- Specified by:
-
remove
in interfaceCollection<K>
- Specified by:
-
remove
in interfaceSet<K>
- Parameters:
-
o
- the key to be removed from the backing map - Returns:
-
true
if the backing map contained the specified key - Throws:
-
NullPointerException
- if the specified key is null
iterator
public Iterator<K> iterator()
The returned iterator is weakly consistent.
add
public boolean add(K e)
- Specified by:
-
add
in interfaceCollection<K>
- Specified by:
-
add
in interfaceSet<K>
- Parameters:
-
e
- key to be added - Returns:
-
true
if this set changed as a result of the call - Throws:
-
NullPointerException
- if the specified key is null -
UnsupportedOperationException
- if no default mapped value for additions was provided
addAll
public boolean addAll(Collection<? extends K> c)
add(K)
on each one.- Specified by:
-
addAll
in interfaceCollection<K>
- Specified by:
-
addAll
in interfaceSet<K>
- Parameters:
-
c
- the elements to be inserted into this set - Returns:
-
true
if this set changed as a result of the call - Throws:
-
NullPointerException
- if the collection or any of its elements arenull
-
UnsupportedOperationException
- if no default mapped value for additions was provided - See Also:
hashCode
public int hashCode()
Object
HashMap
. The general contract of hashCode
is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
equals
public boolean equals(Object o)
Object
The equals
method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
getMap
public ConcurrentHashMap<K,V> getMap()
- Returns:
- the map backing this view
clear
public final void clear()
- Specified by:
-
clear
in interfaceCollection<K>
size
public final int size()
Collection
Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE
.- Specified by:
-
size
in interfaceCollection<K>
- Returns:
- the number of elements in this collection
isEmpty
public final boolean isEmpty()
Collection
true
if this collection contains no elements.- Specified by:
-
isEmpty
in interfaceCollection<K>
- Returns:
-
true
if this collection contains no elements
toArray
public final Object[] toArray()
Collection
Object
. The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
- Specified by:
-
toArray
in interfaceCollection<K>
- Returns:
- an array, whose runtime component type is
Object
, containing all of the elements in this collection
toArray
public final <T> T[] toArray(T[] a)
Collection
If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null
. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null
elements.)
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
- Specified by:
-
toArray
in interfaceCollection<K>
- Type Parameters:
-
T
- the component type of the array to contain the collection - Parameters:
-
a
- the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. - Returns:
- an array containing all of the elements in this collection
toString
public final String toString()
"[]"
). Adjacent elements are separated by the characters ", "
(comma and space). Elements are converted to strings as by String.valueOf(Object)
.containsAll
public final boolean containsAll(Collection<?> c)
Collection
true
if this collection contains all of the elements in the specified collection.- Specified by:
-
containsAll
in interfaceCollection<K>
- Parameters:
-
c
- collection to be checked for containment in this collection - Returns:
-
true
if this collection contains all of the elements in the specified collection - See Also:
removeAll
public boolean removeAll(Collection<?> c)
Collection
- Specified by:
-
removeAll
in interfaceCollection<K>
- Parameters:
-
c
- collection containing elements to be removed from this collection - Returns:
-
true
if this collection changed as a result of the call - See Also:
retainAll
public final boolean retainAll(Collection<?> c)
Collection
- Specified by:
-
retainAll
in interfaceCollection<K>
- Parameters:
-
c
- collection containing elements to be retained in this collection - Returns:
-
true
if this collection changed as a result of the call - See Also:
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ConcurrentHashMap.KeySetView.html