Package eu.simuline.util

Class ListMap.Entries

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Map.Entry<K,V>>

eu.simuline.util.ListMap.Entries

All Implemented Interfaces:

Iterable<Map.Entry<K,V>>, Collection<Map.Entry<K,V>>, Set<Map.Entry<K,V>>, SortedSet<Map.Entry<K,V>>

Enclosing class:

ListMap<K,V>

private class ListMap.Entries
extends AbstractSet<Map.Entry<K,V>>
implements SortedSet<Map.Entry<K,V>>

Represents the set of entries of the enclosing map given by ListMap.entrySet().

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.entrySet

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Entries()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears actually the enclosing ListMap delegating to ListMap.clear().
Comparator<? super Map.Entry<K,V>>	comparator()
boolean	contains(Object obj)	Returns actually whether obj is an instance of Map.Entry with a key contained in the enclosing ListMap delegating to ListMap.containsKey(Object).
Map.Entry<K,V>	first()
private Object	getKey(Object obj)	Assumes that obj is a Map.Entry and returns its key.
SortedSet<Map.Entry<K,V>>	headSet(Map.Entry<K,V> toElement)
Iterator<Map.Entry<K,V>>	iterator()	Returns actually an instance of ListMap.EntriesIterator.
private Map.Entry<K,V>	key2entry(K key)
Map.Entry<K,V>	last()
boolean	remove(Object obj)	Removes obj from the entry set if present and returns whether it was present.
int	size()	Returns actually the size of the enclosing ListMap delegating to ListMap.size().
SortedSet<Map.Entry<K,V>>	subSet(Map.Entry<K,V> fromElement, Map.Entry<K,V> toElement)
SortedSet<Map.Entry<K,V>>	tailSet(Map.Entry<K,V> 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

Entries

private Entries()

Method Detail

iterator

public Iterator<Map.Entry<K,V>> iterator()

Returns actually an instance of ListMap.EntriesIterator.

Specified by:

iterator in interface Collection<Map.Entry<K,V>>

Specified by:

iterator in interface Iterable<Map.Entry<K,V>>

Specified by:

iterator in interface Set<Map.Entry<K,V>>

Specified by:

iterator in class AbstractCollection<Map.Entry<K,V>>

size

public int size()

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

Specified by:

size in interface Collection<Map.Entry<K,V>>

Specified by:

size in interface Set<Map.Entry<K,V>>

Specified by:

size in class AbstractCollection<Map.Entry<K,V>>

getKey

private Object getKey(Object obj)

Assumes that obj is a Map.Entry and returns its key.

Throws:

NullPointerException - if obj is null.

ClassCastException - if obj is neither null nor an instance of Map.Entry.

contains

public boolean contains(Object obj)

Returns actually whether obj is an instance of Map.Entry with a key contained in the enclosing ListMap delegating to ListMap.containsKey(Object).

Specified by:

contains in interface Collection<Map.Entry<K,V>>

Specified by:

contains in interface Set<Map.Entry<K,V>>

Overrides:

contains in class AbstractCollection<Map.Entry<K,V>>

remove

public boolean remove(Object obj)

Removes obj from the entry set if present and returns whether it was present. Effectively checks whether obj is an instance of Map.Entry. If not returns false. If it is an instance of Map.Entry removes the according key-value pair from the enclosing ListMap if present. Returns whether obj's key was present when invoking this method. This is done invoking ListMap.Keys.remove(Object).

Specified by:

remove in interface Collection<Map.Entry<K,V>>

Specified by:

remove in interface Set<Map.Entry<K,V>>

Overrides:

remove in class AbstractCollection<Map.Entry<K,V>>

clear

public void clear()

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

Specified by:

clear in interface Collection<Map.Entry<K,V>>

Specified by:

clear in interface Set<Map.Entry<K,V>>

Overrides:

clear in class AbstractCollection<Map.Entry<K,V>>

comparator

public Comparator<? super Map.Entry<K,V>> comparator()

Specified by:

comparator in interface SortedSet<Map.Entry<K,V>>

key2entry

private Map.Entry<K,V> key2entry(K key)

first

public Map.Entry<K,V> first()

Specified by:

first in interface SortedSet<Map.Entry<K,V>>

last

public Map.Entry<K,V> last()

Specified by:

last in interface SortedSet<Map.Entry<K,V>>

subSet

public SortedSet<Map.Entry<K,V>> subSet(Map.Entry<K,V> fromElement,
                                              Map.Entry<K,V> toElement)

Specified by:

subSet in interface SortedSet<Map.Entry<K,V>>

headSet

public SortedSet<Map.Entry<K,V>> headSet(Map.Entry<K,V> toElement)

Specified by:

headSet in interface SortedSet<Map.Entry<K,V>>

tailSet

public SortedSet<Map.Entry<K,V>> tailSet(Map.Entry<K,V> fromElement)

Specified by:

tailSet in interface SortedSet<Map.Entry<K,V>>