Package squidpony.squidmath

Class OrderedMap.KeySet

java.lang.Object

squidpony.squidmath.OrderedMap.KeySet

All Implemented Interfaces:

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

Enclosing class:

OrderedMap<K,V>

public final class OrderedMap.KeySet
extends Object
implements SortedSet<K>, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
KeySet()

Method Summary

Modifier and Type	Method	Description
boolean	add(K o)	Always throws an UnsupportedOperationException
boolean	addAll(Collection<? extends K> c)	Adds all elements of the given collection to this collection.
void	clear()
Comparator<K>	comparator()
boolean	contains(Object o)	Delegates to the corresponding type-specific method.
boolean	containsAll(Collection<?> c)	Checks whether this collection contains all elements from the given type-specific collection.
boolean	equals(Object o)
K	first()
SortedSet<K>	headSet(K to)
boolean	isEmpty()
OrderedMap.KeyIterator	iterator()
K	last()
boolean	remove(Object ok)	Always throws an UnsupportedOperationException
boolean	removeAll(Collection<?> c)	Remove from this collection all elements in the given type-specific collection.
boolean	retainAll(Collection<?> c)	Retains in this collection only elements from the given type-specific collection.
int	size()
SortedSet<K>	subSet(K from, K to)
SortedSet<K>	tailSet(K from)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()
int	unwrap(OrderedMap.KeyIterator i, Object[] array)	Unwraps an iterator into an array.
int	unwrap(OrderedMap.KeyIterator i, Object[] array, int offset, int max)	Unwraps an iterator into an array starting at a given offset for a given number of elements.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, 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

hashCode

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details

KeySet

public KeySet()

Method Details

iterator

public OrderedMap.KeyIterator iterator()

Specified by:

iterator in interface Collection<K>

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface Set<K>

size

public int size()

Specified by:

size in interface Collection<K>

Specified by:

size in interface Set<K>

clear

public void clear()

Specified by:

clear in interface Collection<K>

Specified by:

clear in interface Set<K>

first

public K first()

Specified by:

first in interface SortedSet<K>

last

public K last()

Specified by:

last in interface SortedSet<K>

comparator

public Comparator<K> comparator()

Specified by:

comparator in interface SortedSet<K>

tailSet

public final SortedSet<K> tailSet(K from)

Specified by:

tailSet in interface SortedSet<K>

headSet

public final SortedSet<K> headSet(K to)

Specified by:

headSet in interface SortedSet<K>

subSet

public final SortedSet<K> subSet(K from, K to)

Specified by:

subSet in interface SortedSet<K>

toArray

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

Specified by:

toArray in interface Collection<K>

Specified by:

toArray in interface Set<K>

remove

public boolean remove(Object ok)

Always throws an UnsupportedOperationException

Specified by:

remove in interface Collection<K>

Specified by:

remove in interface Set<K>

add

public boolean add(K o)

Always throws an UnsupportedOperationException

Specified by:

add in interface Collection<K>

Specified by:

add in interface Set<K>

contains

public boolean contains(Object o)

Delegates to the corresponding type-specific method.

Specified by:

contains in interface Collection<K>

Specified by:

contains in interface Set<K>

containsAll

public boolean containsAll(Collection<?> c)

Checks whether this collection contains all elements from the given type-specific collection.

Specified by:

containsAll in interface Collection<K>

Specified by:

containsAll in interface Set<K>

Parameters:

c - a type-specific collection.

Returns:

true if this collection contains all elements of the argument.

retainAll

public boolean retainAll(Collection<?> c)

Retains in this collection only elements from the given type-specific collection.

Specified by:

retainAll in interface Collection<K>

Specified by:

retainAll in interface Set<K>

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

removeAll

public boolean removeAll(Collection<?> c)

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface Collection<K>

Specified by:

removeAll in interface Set<K>

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<K>

Specified by:

toArray in interface Set<K>

addAll

public boolean addAll(Collection<? extends K> c)

Adds all elements of the given collection to this collection.

Specified by:

addAll in interface Collection<K>

Specified by:

addAll in interface Set<K>

Parameters:

c - a collection.

Returns:

true if this collection changed as a result of the call.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<K>

Specified by:

equals in interface Set<K>

Overrides:

equals in class Object

unwrap

public int unwrap(OrderedMap.KeyIterator i, Object[] array, int offset, int max)

Unwraps an iterator into an array starting at a given offset for a given number of elements.

This method iterates over the given type-specific iterator and stores the elements returned, up to a maximum of length, in the given array starting at offset. The number of actually unwrapped elements is returned (it may be less than max if the iterator emits less than max elements).

Parameters:

i - a type-specific iterator.

array - an array to contain the output of the iterator.

offset - the first element of the array to be returned.

max - the maximum number of elements to unwrap.

Returns:

the number of elements unwrapped.

unwrap

public int unwrap(OrderedMap.KeyIterator i, Object[] array)

Unwraps an iterator into an array.

This method iterates over the given type-specific iterator and stores the elements returned in the given array. The iteration will stop when the iterator has no more elements or when the end of the array has been reached.

Parameters:

i - a type-specific iterator.

array - an array to contain the output of the iterator.

Returns:

the number of elements unwrapped.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<K>

Specified by:

isEmpty in interface Set<K>

toString

public String toString()

Overrides:

toString in class Object