Package org.apache.sis.util.collection

Class FrequencySortedSet.SubSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.apache.sis.util.collection.FrequencySortedSet.SubSet

All Implemented Interfaces:

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

Enclosing class:

FrequencySortedSet<E>

private final class FrequencySortedSet.SubSet
extends AbstractSet<E>
implements SortedSet<E>, Serializable

A view over a subset of FrequencySortedSet.

Field Summary

Fields

Modifier and Type	Field	Description
private E[]	elements	Reference to the FrequencySortedSet.sorted array, used for detecting changes.
private final E	fromElement	Low endpoint (inclusive) of the subset.
private final boolean	hasFrom	Whether the set should take in account fromElement or toElement.
private final boolean	hasTo	Whether the set should take in account fromElement or toElement.
private int	lower	Lower and upper index computed from fromElement and toElement.
private static final long	serialVersionUID	For cross-version compatibility.
private final E	toElement	High endpoint (exclusive) of the subset.
private int	upper	Lower and upper index computed from fromElement and toElement.

Constructor Summary

Constructors

Constructor	Description
SubSet(boolean hasFrom, E fromElement, boolean hasTo, E toElement)	Creates a new subset from the lower element (inclusive) to the upper element (exclusive).

Method Summary

Modifier and Type	Method	Description
Comparator<E>	comparator()	Returns the comparator, which is the same than FrequencySortedSet.comparator().
private void	ensureValidRange()	Ensures that lower and upper indices are valid.
E	first()	Returns the first element in this subset.
SortedSet<E>	headSet(E to)	Returns a view of the portion of this subset whose elements occur with a frequency strictly less than toElement frequency.
Iterator<E>	iterator()	Returns an iterator over the elements in this subset.
E	last()	Returns the last element in this subset.
int	size()	Returns the number of elements in this subset.
SortedSet<E>	subSet(E from, E to)	Returns a view of the portion of this subset whose elements occur with a frequency in the range of fromElement frequency inclusive to toElement frequency exclusive.
private SortedSet<E>	subSet(E from, E to, int bounded)	Implementation of headSet(Object), tailSet(Object) and subSet(Object, Object).
SortedSet<E>	tailSet(E from)	Returns a view of the portion of this subset whose elements occur with a frequency equal or greater than fromElement frequency.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, 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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.SortedSet

spliterator

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

elements

private transient E[] elements

Reference to the FrequencySortedSet.sorted array, used for detecting changes.

fromElement

private final E fromElement

Low endpoint (inclusive) of the subset. May be null.

toElement

private final E toElement

High endpoint (exclusive) of the subset. May be null.

hasFrom

private final boolean hasFrom

Whether the set should take in account fromElement or toElement. We have to use those booleans (we cannot use null sentinel value instead) because null is a legal value for from/toElement.

hasTo

private final boolean hasTo

Whether the set should take in account fromElement or toElement. We have to use those booleans (we cannot use null sentinel value instead) because null is a legal value for from/toElement.

lower

private transient int lower

Lower and upper index computed from fromElement and toElement.

upper

private transient int upper

Lower and upper index computed from fromElement and toElement.

Constructor Details

SubSet

SubSet(boolean hasFrom,
 E fromElement,
 boolean hasTo,
 E toElement)

Creates a new subset from the lower element (inclusive) to the upper element (exclusive). Each endpoint can be null.

Method Details

comparator

public Comparator<E> comparator()

Returns the comparator, which is the same than FrequencySortedSet.comparator().

Specified by:

comparator in interface SortedSet<E>

ensureValidRange

private void ensureValidRange()

Ensures that lower and upper indices are valid.

iterator

public Iterator<E> iterator()

Returns an iterator over the elements in this subset.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

size

public int size()

Returns the number of elements in this subset.

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

first

public E first()

Returns the first element in this subset.

Specified by:

first in interface SortedSet<E>

See Also:

• FrequencySortedSet.first()

last

public E last()

Returns the last element in this subset.

Specified by:

last in interface SortedSet<E>

See Also:

• FrequencySortedSet.last()

headSet

public SortedSet<E> headSet(E to)

Returns a view of the portion of this subset whose elements occur with a frequency strictly less than toElement frequency.

Specified by:

headSet in interface SortedSet<E>

See Also:

• FrequencySortedSet.headSet(Object)

tailSet

public SortedSet<E> tailSet(E from)

Returns a view of the portion of this subset whose elements occur with a frequency equal or greater than fromElement frequency.

Specified by:

tailSet in interface SortedSet<E>

See Also:

• FrequencySortedSet.tailSet(Object)

subSet

public SortedSet<E> subSet(E from,
 E to)

Returns a view of the portion of this subset whose elements occur with a frequency in the range of fromElement frequency inclusive to toElement frequency exclusive.

Specified by:

subSet in interface SortedSet<E>

See Also:

• FrequencySortedSet.subSet(Object, Object)

subSet

private SortedSet<E> subSet(E from,
 E to,
 int bounded)

Implementation of headSet(Object), tailSet(Object) and subSet(Object, Object). The bounds argument tell which FrequencySortedSet method to delegate to.