Package io.permazen.util

Class ImmutableNavigableSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

io.permazen.util.AbstractIterationSet<E>

io.permazen.util.AbstractNavigableSet<E>

io.permazen.util.ImmutableNavigableSet<E>

Type Parameters:

E - element type

All Implemented Interfaces:

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

public class ImmutableNavigableSet<E>
extends AbstractNavigableSet<E>

An immutable NavigableSet implementation optimized for read efficiency.

Because the elements are stored in an array, it's also possible to get the element by index; see get().

Field Summary

Fields inherited from class io.permazen.util.AbstractNavigableSet

bounds

Constructor Summary

Constructors

Constructor	Description
ImmutableNavigableSet(E[] elems, int minIndex, int maxIndex, Comparator<? super E> comparator)	Primary constructor.
ImmutableNavigableSet(E[] elems, Comparator<? super E> comparator)	Convenience constructor.
ImmutableNavigableSet(NavigableSet<E> source)	Constructor.
ImmutableNavigableSet(NavigableSet<E> source, Comparator<? super E> comparator)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	binarySearch(E elem)	Search for the given element in the underlying array.
protected Spliterator<E>	buildSpliterator(Iterator<E> iterator)	Build a Spliterator appropriate for this set from the given instance iterator.
E	ceiling(E elem)
Comparator<? super E>	comparator()
boolean	contains(Object obj)
protected ImmutableNavigableSet<E>	createSubSet(boolean reverse, Bounds<E> newBounds)	Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds.
CloseableIterator<E>	descendingIterator()
E	first()
E	floor(E elem)
E	get(int index)	Get the element at the specified index.
E	higher(E elem)
boolean	isEmpty()	Overridden in AbstractIterationSet to minimize the use of AbstractIterationSet.size().
CloseableIterator<E>	iterator()
E	last()
E	lower(E elem)
E	pollFirst()
E	pollLast()
int	size()	Calculate size.
Spliterator<E>	spliterator()	Overridden in AbstractIterationSet to avoid the use of AbstractIterationSet.size().
Stream<E>	stream()

Methods inherited from class io.permazen.util.AbstractNavigableSet

descendingSet, getBounds, getComparator, headSet, headSet, isWithinLowerBound, isWithinUpperBound, remove, searchAbove, searchBelow, subSet, subSet, tailSet, tailSet

Methods inherited from class io.permazen.util.AbstractIterationSet

equals, hashCode, toArray, toArray

Methods inherited from class java.util.AbstractSet

removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, containsAll, retainAll, 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, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Constructor Details

ImmutableNavigableSet

public ImmutableNavigableSet(NavigableSet<E> source)

Constructor.

Parameters:

source - data source

Throws:

IllegalArgumentException - if source is null

ImmutableNavigableSet

public ImmutableNavigableSet(NavigableSet<E> source,
 Comparator<? super E> comparator)

Constructor.

Parameters:

source - data source

comparator - element comparator, or null for natural ordering

Throws:

IllegalArgumentException - if source is null

ImmutableNavigableSet

public ImmutableNavigableSet(E[] elems,
 Comparator<? super E> comparator)

Convenience constructor.

Equivalent to: ImmutableNavigableSet(elems, 0, elems.length, comparator).

Parameters:

elems - sorted element array; this array is not copied and must be already sorted

comparator - element comparator, or null for natural ordering

Throws:

IllegalArgumentException - if elems is null

ImmutableNavigableSet

public ImmutableNavigableSet(E[] elems,
 int minIndex,
 int maxIndex,
 Comparator<? super E> comparator)

Primary constructor.

Parameters:

elems - sorted element array; this array is not copied and must be already sorted

minIndex - minimum index into array (inclusive)

maxIndex - maximum index into array (exclusive)

comparator - element comparator, or null for natural ordering

Throws:

IllegalArgumentException - if elems is null

IllegalArgumentException - if elems has length less than maxIndex

IllegalArgumentException - if minIndex > maxIndex

Method Details

get

public E get(int index)

Get the element at the specified index.

Parameters:

index - index into the ordered element array

Returns:

the element at the specified index

Throws:

IndexOutOfBoundsException - if index is negative or greater than or equal to size()

binarySearch

public int binarySearch(E elem)

Search for the given element in the underlying array.

This method works like Arrays.binarySearch(), returning either the index of elem in the underlying array given to the constructor if found, or else the one's complement of elem's insertion point.

The array searched is the array given to the constructor, or if ImmutableNavigableSet(NavigableSet) was used, an array containing all of the elements in this set.

Parameters:

elem - element to search for

Returns:

index of elem, or -(insertion point) - 1 if not found

comparator

public Comparator<? super E> comparator()

isEmpty

public boolean isEmpty()

Description copied from class: AbstractIterationSet

Overridden in AbstractIterationSet to minimize the use of AbstractIterationSet.size().

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractIterationSet<E>

size

public int size()

Description copied from class: AbstractIterationSet

Calculate size.

The implementation in AbstractIterationSet iterates through all of the elements.

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Overrides:

size in class AbstractIterationSet<E>

contains

public boolean contains(Object obj)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

first

public E first()

Specified by:

first in interface SortedSet<E>

Overrides:

first in class AbstractNavigableSet<E>

last

public E last()

Specified by:

last in interface SortedSet<E>

Overrides:

last in class AbstractNavigableSet<E>

pollFirst

public E pollFirst()

Specified by:

pollFirst in interface NavigableSet<E>

Overrides:

pollFirst in class AbstractNavigableSet<E>

pollLast

public E pollLast()

Specified by:

pollLast in interface NavigableSet<E>

Overrides:

pollLast in class AbstractNavigableSet<E>

lower

public E lower(E elem)

Specified by:

lower in interface NavigableSet<E>

Overrides:

lower in class AbstractNavigableSet<E>

floor

public E floor(E elem)

Specified by:

floor in interface NavigableSet<E>

Overrides:

floor in class AbstractNavigableSet<E>

higher

public E higher(E elem)

Specified by:

higher in interface NavigableSet<E>

Overrides:

higher in class AbstractNavigableSet<E>

ceiling

public E ceiling(E elem)

Specified by:

ceiling in interface NavigableSet<E>

Overrides:

ceiling in class AbstractNavigableSet<E>

iterator

public CloseableIterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface NavigableSet<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractIterationSet<E>

descendingIterator

public CloseableIterator<E> descendingIterator()

Specified by:

descendingIterator in interface NavigableSet<E>

Overrides:

descendingIterator in class AbstractNavigableSet<E>

spliterator

public Spliterator<E> spliterator()

Description copied from class: AbstractIterationSet

Overridden in AbstractIterationSet to avoid the use of AbstractIterationSet.size().

Note: the underlying CloseableIterator is not closed when this method is used. Prefer using AbstractIterationSet.buildSpliterator(java.util.Iterator<E>) and arranging for the iterator to be closed separately.

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

Specified by:

spliterator in interface Set<E>

Specified by:

spliterator in interface SortedSet<E>

Overrides:

spliterator in class AbstractIterationSet<E>

stream

public Stream<E> stream()

Description copied from class: AbstractIterationSet

The implementation in AbstractIterationSet build a stream from the results from AbstractIterationSet.iterator() and buildSpliterator(), and marks the iterator for close via Stream.onClose().

Specified by:

stream in interface Collection<E>

Overrides:

stream in class AbstractIterationSet<E>

buildSpliterator

protected Spliterator<E> buildSpliterator(Iterator<E> iterator)

Description copied from class: AbstractIterationSet

Build a Spliterator appropriate for this set from the given instance iterator.

Implementations should probably use Spliterators.spliteratorUnknownSize() unless the size is known.

Overrides:

buildSpliterator in class AbstractNavigableSet<E>

Parameters:

iterator - a new iterator returned from {#link #iterator}

createSubSet

protected ImmutableNavigableSet<E> createSubSet(boolean reverse,
 Bounds<E> newBounds)

Description copied from class: AbstractNavigableSet

Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds. The newBounds are consistent with the new ordering (i.e., reversed relative to this instance's ordering if reverse is true) and have already been range-checked against this instance's current bounds.

Specified by:

createSubSet in class AbstractNavigableSet<E>

Parameters:

reverse - whether the new set's ordering should be reversed relative to this instance's ordering

newBounds - new bounds

Returns:

restricted and/or reversed view of this instance