Package eu.simuline.util

Class ListMap.Keys

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<K>

eu.simuline.util.ListMap.Keys

All Implemented Interfaces:

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

Enclosing class:

ListMap<K,V>

private class ListMap.Keys
extends AbstractSet<K>
implements SortedSet<K>

Represents the key set of the enclosing map given by ListMap.keySet().

Like base class AbstractSet, this class supports neither Set.add(Object) nor Set.addAll(Collection), i.e. those methods throw an UnsupportedOperationException. In contrast, this class supports methods Set.clear(), Set.remove(Object), Set.removeAll(Collection) and Set.retainAll(Collection). The iterator returned by iterator() supports Iterator.remove().

See Also:

ListMap.keysSet

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Keys()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears actually the enclosing ListMap delegating to ListMap.clear().
Comparator<? super K>	comparator()
boolean	contains(Object obj)	Returns actually whether obj is a key of the enclosing ListMap delegating to ListMap.containsKey(Object).
K	first()
SortedSet<K>	headSet(K toElement)
Iterator<K>	iterator()	Returns actually an instance of ListMap.KeysIterator.
K	last()
boolean	remove(Object obj)	Interpretes obj as key of the enclosing ListMap and removes the according key-value pair if present.
int	size()	Returns actually the size of the enclosing ListMap delegating to ListMap.size().
SortedSet<K>	subSet(K fromElement, K toElement)
SortedSet<K>	tailSet(K fromElement)

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, containsAll, isEmpty, retainAll, toArray, toArray, 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, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Detail

Keys

private Keys()

Method Detail

iterator

public Iterator<K> iterator()

Returns actually an instance of ListMap.KeysIterator.

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>

size

public int size()

Returns actually the size of the enclosing ListMap delegating to ListMap.size().

Specified by:

size in interface Collection<K>

Specified by:

size in interface Set<K>

Specified by:

size in class AbstractCollection<K>

contains

public boolean contains(Object obj)

Returns actually whether obj is a key of the enclosing ListMap delegating to ListMap.containsKey(Object).

Specified by:

contains in interface Collection<K>

Specified by:

contains in interface Set<K>

Overrides:

contains in class AbstractCollection<K>

remove

public boolean remove(Object obj)

Interpretes obj as key of the enclosing ListMap and removes the according key-value pair if present. Returns whether the according key-value pair was present when invoking this method using ListMap.removeIdx(int).

Specified by:

remove in interface Collection<K>

Specified by:

remove in interface Set<K>

Overrides:

remove in class AbstractCollection<K>

clear

public void clear()

Clears actually the enclosing ListMap delegating to ListMap.clear().

Specified by:

clear in interface Collection<K>

Specified by:

clear in interface Set<K>

Overrides:

clear in class AbstractCollection<K>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedSet<K>

first

public K first()

Specified by:

first in interface SortedSet<K>

last

public K last()

Specified by:

last in interface SortedSet<K>

subSet

public SortedSet<K> subSet(K fromElement,
                           K toElement)

Specified by:

subSet in interface SortedSet<K>

headSet

public SortedSet<K> headSet(K toElement)

Specified by:

headSet in interface SortedSet<K>

tailSet

public SortedSet<K> tailSet(K fromElement)

Specified by:

tailSet in interface SortedSet<K>