Package com.tangosol.util

Class SafeHashMap.KeySet

java.lang.Object

java.util.AbstractCollection<K>

java.util.AbstractSet<K>

com.tangosol.util.SafeHashMap.KeySet

All Implemented Interfaces:

Serializable, Iterable<K>, Collection<K>, Set<K>

Direct Known Subclasses:

LocalCache.KeySet

Enclosing class:

SafeHashMap<K,V>

protected class SafeHashMap.KeySet
extends AbstractSet<K>
implements Serializable

A set of entries backed by this map.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeySet()

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all of the elements from this set of Keys by clearing the underlying Map.
boolean	contains(Object oKey)	Determine if a particular key is present in the Set.
Iterator<K>	iterator()	Obtain an iterator over the keys in the Map.
boolean	remove(Object o)	Removes the specified element from this Set of keys if it is present by removing the associated entry from the underlying Map.
int	size()	Determine the number of keys in the Set.
Object[]	toArray()	Returns an array containing all of the keys in this set.
<T> T[]	toArray(T[] a)	Returns an array with a runtime type is that of the specified array and that contains all of the keys in this Set.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, containsAll, isEmpty, retainAll, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, containsAll, isEmpty, retainAll, spliterator

Constructor Details

KeySet

protected KeySet()

Method Details

iterator

public Iterator<K> iterator()

Obtain an iterator over the keys in the Map.

Specified by:

iterator in interface Collection<K>

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface Set<K>

Specified by:

iterator in class AbstractCollection<K>

Returns:

an Iterator that provides a live view of the keys in the underlying Map object

size

public int size()

Determine the number of keys in the Set.

Specified by:

size in interface Collection<K>

Specified by:

size in interface Set<K>

Specified by:

size in class AbstractCollection<K>

Returns:

the number of keys in the Set, which is the same as the number of entries in the underlying Map

contains

public boolean contains(Object oKey)

Determine if a particular key is present in the Set.

Specified by:

contains in interface Collection<K>

Specified by:

contains in interface Set<K>

Overrides:

contains in class AbstractCollection<K>

Returns:

true iff the passed key object is in the key Set

remove

public boolean remove(Object o)

Removes the specified element from this Set of keys if it is present by removing the associated entry from the underlying Map.

Specified by:

remove in interface Collection<K>

Specified by:

remove in interface Set<K>

Overrides:

remove in class AbstractCollection<K>

Parameters:

o - object to be removed from this set, if present

Returns:

true if the set contained the specified element

clear

public void clear()

Removes all of the elements from this set of Keys by clearing the underlying Map.

Specified by:

clear in interface Collection<K>

Specified by:

clear in interface Set<K>

Overrides:

clear in class AbstractCollection<K>

toArray

public Object[] toArray()

Returns an array containing all of the keys in this set.

Specified by:

toArray in interface Collection<K>

Specified by:

toArray in interface Set<K>

Overrides:

toArray in class AbstractCollection<K>

Returns:

an array containing all of the keys in this set

toArray

public <T> T[] toArray(T[] a)

Returns an array with a runtime type is that of the specified array and that contains all of the keys in this Set. If the Set fits in the specified array, it is returned there = in. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If the Set fits in the specified array with room to spare (i.e., the array has more elements than the Set), the element in the array immediately following the end of the Set is set to null. This is useful in determining the length of the Set only if the caller knows that the Set does not contain any null keys.)

Specified by:

toArray in interface Collection<K>

Specified by:

toArray in interface Set<K>

Overrides:

toArray in class AbstractCollection<K>

Parameters:

a - the array into which the elements of the Set 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 the elements of the Set

Throws:

ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this Set of keys