Package io.permazen.util

Class ConvertedNavigableSet<E,W>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

io.permazen.util.AbstractIterationSet<E>

io.permazen.util.AbstractNavigableSet<E>

io.permazen.util.ConvertedNavigableSet<E,W>

Type Parameters:

E - element type of this set

W - element type of the wrapped set

All Implemented Interfaces:

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

public class ConvertedNavigableSet<E,W>
extends AbstractNavigableSet<E>

Provides a transformed view of a wrapped NavigableSet using a strictly invertable Converter.

Supplied Converters may throw ClassCastException or IllegalArgumentException if given an objects whose runtime type does not match the expected type.

Field Summary

Fields inherited from class io.permazen.util.AbstractNavigableSet

bounds

Constructor Summary

Constructors

Constructor	Description
ConvertedNavigableSet(NavigableSet<W> set, Converter<E,W> converter)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	add(E obj)
void	clear()
Comparator<? super E>	comparator()
boolean	contains(Object obj)
protected NavigableSet<E>	createSubSet(boolean reverse, Bounds<E> newBounds)	Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds.
Converter<E,W>	getConverter()	Get the Converter associated with this instance.
NavigableSet<W>	getWrappedNavigableSet()	Get the wrapped NavigableSet.
boolean	isEmpty()	Overridden in AbstractIterationSet to minimize the use of AbstractIterationSet.size().
CloseableIterator<E>	iterator()
boolean	remove(Object obj)	Removes the given element from this set if it is present.
protected E	searchAbove(E elem, boolean inclusive)	Search for a higher element.
protected E	searchBelow(E elem, boolean inclusive)	Search for a lower element.
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

buildSpliterator, ceiling, descendingIterator, descendingSet, first, floor, getBounds, getComparator, headSet, headSet, higher, isWithinLowerBound, isWithinUpperBound, last, lower, pollFirst, pollLast, 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

addAll, 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

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

Constructor Details

ConvertedNavigableSet

public ConvertedNavigableSet(NavigableSet<W> set,
 Converter<E,W> converter)

Constructor.

Parameters:

set - wrapped set

converter - element converter

Throws:

IllegalArgumentException - if either parameter is null

Method Details

getWrappedNavigableSet

public NavigableSet<W> getWrappedNavigableSet()

Get the wrapped NavigableSet.

Returns:

the wrapped NavigableSet.

getConverter

public Converter<E,W> getConverter()

Get the Converter associated with this instance.

Returns:

associated Converter

comparator

public Comparator<? super E> comparator()

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>

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>

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>

add

public boolean add(E obj)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

remove

public boolean remove(Object obj)

Description copied from class: AbstractNavigableSet

Removes the given element from this set if it is present.

The implementation in AbstractNavigableSet always throws UnsupportedOperationException.

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractNavigableSet<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

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>

searchBelow

protected E searchBelow(E elem,
 boolean inclusive)

Description copied from class: AbstractNavigableSet

Search for a lower element. Used to implement floor() and lower().

The implementation in AbstractNavigableSet checks the bounds then returns the first element from a head set.

Overrides:

searchBelow in class AbstractNavigableSet<E>

Parameters:

elem - upper limit for search

inclusive - true if elem itself is a candidate

Returns:

highest element below elem, or null if not found

searchAbove

protected E searchAbove(E elem,
 boolean inclusive)

Description copied from class: AbstractNavigableSet

Search for a higher element. Used to implement ceiling() and higher().

The implementation in AbstractNavigableSet checks the bounds then returns the first element from a tail set.

Overrides:

searchAbove in class AbstractNavigableSet<E>

Parameters:

elem - lower limit for search

inclusive - true if elem itself is a candidate

Returns:

lowest element above elem, or null if not found

createSubSet

protected NavigableSet<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