Package org.apache.sis.util.collection

Class RangeSet.SubSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Range<E>>

org.apache.sis.util.collection.RangeSet.SubSet

All Implemented Interfaces:

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

Enclosing class:

RangeSet<E extends Comparable<? super E>>

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

A view over a subset of RangeSet. Instances of this class are created by the RangeSet.intersect(Range) method.

See Also:

• RangeSet.intersect(Range)

Field Summary

Fields

Modifier and Type	Field	Description
private int	lower	Index of subRange minimum and maximum values in the array of the enclosing RangeSet.
private int	modCount	Modification count of the enclosing RangeSet, used for detecting changes.
private static final long	serialVersionUID	For cross-version compatibility.
private Range<E>	subRange	The minimal and maximal values of this subset,
private int	upper	Index of subRange minimum and maximum values in the array of the enclosing RangeSet.

Constructor Summary

Constructors

Constructor	Description
SubSet(Range<E> subRange)	Creates a new subset of the enclosing RangeSet between the given values.

Method Summary

Modifier and Type	Method	Description
boolean	add(Range<E> range)	Adds a new range in the enclosing RangeSet, and updates this subset in order to contain that range.
void	clear()	Clears this subset by removing all elements in the range given to the constructor.
Comparator<Range<E>>	comparator()	Returns the comparator, which is the same than the enclosing class.
boolean	contains(Object object)	Tests if this subset contains the given range.
Range<E>	first()	Returns the first range in this subset, intersected with the range given to the constructor.
SortedSet<Range<E>>	headSet(Range<E> toElement)	Delegates subset creation to the enclosing class.
Iterator<Range<E>>	iterator()	Returns an iterator over the elements in this subset.
Range<E>	last()	Returns the last range in this subset, intersected with the range given to the constructor.
boolean	remove(Object object)	Removes the given range or part of it from the enclosing RangeSet.
int	size()	Returns the number of ranges in this subset.
SortedSet<Range<E>>	subSet(Range<E> fromElement, Range<E> toElement)	Delegates subset creation to the enclosing class.
SortedSet<Range<E>>	tailSet(Range<E> fromElement)	Delegates subset creation to the enclosing class.
private void	updateBounds()	Recomputes the lower and upper indices if they are outdated.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, isEmpty, 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

subRange

private Range<E extends Comparable<? super E>> subRange

The minimal and maximal values of this subset,

lower

private transient int lower

Index of subRange minimum and maximum values in the array of the enclosing RangeSet. Those indices need to be recomputed every time the enclosing RangeSet has been modified.

See Also:

• updateBounds()

upper

private transient int upper

Index of subRange minimum and maximum values in the array of the enclosing RangeSet. Those indices need to be recomputed every time the enclosing RangeSet has been modified.

See Also:

• updateBounds()

modCount

private transient int modCount

Modification count of the enclosing RangeSet, used for detecting changes.

Constructor Details

SubSet

SubSet(Range<E> subRange)

Creates a new subset of the enclosing RangeSet between the given values.

Parameters:

subRange - the range to intersect with the enclosing RangeSet.

Method Details

updateBounds

private void updateBounds()

Recomputes the lower and upper indices if they are outdated. If the indices are already up to date, then this method does nothing.

comparator

public Comparator<Range<E>> comparator()

Returns the comparator, which is the same than the enclosing class.

Specified by:

comparator in interface SortedSet<Range<E extends Comparable<? super E>>>

clear

public void clear()

Clears this subset by removing all elements in the range given to the constructor.

Specified by:

clear in interface Collection<Range<E extends Comparable<? super E>>>

Specified by:

clear in interface Set<Range<E extends Comparable<? super E>>>

Overrides:

clear in class AbstractCollection<Range<E extends Comparable<? super E>>>

size

public int size()

Returns the number of ranges in this subset.

Specified by:

size in interface Collection<Range<E extends Comparable<? super E>>>

Specified by:

size in interface Set<Range<E extends Comparable<? super E>>>

Specified by:

size in class AbstractCollection<Range<E extends Comparable<? super E>>>

add

public boolean add(Range<E> range)

Adds a new range in the enclosing RangeSet, and updates this subset in order to contain that range.

Specified by:

add in interface Collection<Range<E extends Comparable<? super E>>>

Specified by:

add in interface Set<Range<E extends Comparable<? super E>>>

Overrides:

add in class AbstractCollection<Range<E extends Comparable<? super E>>>

remove

public boolean remove(Object object)

Removes the given range or part of it from the enclosing RangeSet. Before to perform the removal, this method intersects the given range with the range of this subset.

Specified by:

remove in interface Collection<Range<E extends Comparable<? super E>>>

Specified by:

remove in interface Set<Range<E extends Comparable<? super E>>>

Overrides:

remove in class AbstractCollection<Range<E extends Comparable<? super E>>>

contains

public boolean contains(Object object)

Tests if this subset contains the given range. Before to delegates to the enclosing class, this method filter-out the ranges that are not contained in the range given to the constructor of this subset.

Specified by:

contains in interface Collection<Range<E extends Comparable<? super E>>>

Specified by:

contains in interface Set<Range<E extends Comparable<? super E>>>

Overrides:

contains in class AbstractCollection<Range<E extends Comparable<? super E>>>

first

public Range<E> first()

Returns the first range in this subset, intersected with the range given to the constructor.

Specified by:

first in interface SortedSet<Range<E extends Comparable<? super E>>>

last

public Range<E> last()

Returns the last range in this subset, intersected with the range given to the constructor.

Specified by:

last in interface SortedSet<Range<E extends Comparable<? super E>>>

subSet

public SortedSet<Range<E>> subSet(Range<E> fromElement,
 Range<E> toElement)

Delegates subset creation to the enclosing class. The new subset will not be bigger than this subset.

Specified by:

subSet in interface SortedSet<Range<E extends Comparable<? super E>>>

headSet

public SortedSet<Range<E>> headSet(Range<E> toElement)

Delegates subset creation to the enclosing class. The new subset will not be bigger than this subset.

Specified by:

headSet in interface SortedSet<Range<E extends Comparable<? super E>>>

tailSet

public SortedSet<Range<E>> tailSet(Range<E> fromElement)

Delegates subset creation to the enclosing class. The new subset will not be bigger than this subset.

Specified by:

tailSet in interface SortedSet<Range<E extends Comparable<? super E>>>

iterator

public Iterator<Range<E>> iterator()

Returns an iterator over the elements in this subset.

Specified by:

iterator in interface Collection<Range<E extends Comparable<? super E>>>

Specified by:

iterator in interface Iterable<Range<E extends Comparable<? super E>>>

Specified by:

iterator in interface Set<Range<E extends Comparable<? super E>>>

Specified by:

iterator in class AbstractCollection<Range<E extends Comparable<? super E>>>