public abstract class ForwardingNavigableSet<E> extends ForwardingSortedSet<E> implements java.util.NavigableSet<E>
Warning: The methods of ForwardingNavigableSet
forward indiscriminately
to the methods of the delegate. For example, overriding ForwardingCollection.add(E)
alone will not
change the behavior of ForwardingCollection.addAll(java.util.Collection<? extends E>)
, which can lead to unexpected behavior. In this case, you
should override addAll
as well, either providing your own implementation, or delegating
to the provided standardAddAll
method.
Each of the standard
methods uses the set's comparator (or the natural ordering of
the elements, if there is no comparator) to test element equality. As a result, if the
comparator is not consistent with equals, some of the standard implementations may violate the
Set
contract.
The standard
methods and the collection views they return are not guaranteed to be
thread-safe, even when all of the methods that they depend on are thread-safe.
Modifier and Type | Class and Description |
---|---|
protected class |
ForwardingNavigableSet.StandardDescendingSet
A sensible implementation of
NavigableSet.descendingSet() in terms of the other methods
of NavigableSet , notably including NavigableSet.descendingIterator() . |
Modifier | Constructor and Description |
---|---|
protected |
ForwardingNavigableSet()
Constructor for use by subclasses.
|
Modifier and Type | Method and Description |
---|---|
E |
ceiling(E e) |
protected abstract java.util.NavigableSet<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
java.util.Iterator<E> |
descendingIterator() |
java.util.NavigableSet<E> |
descendingSet() |
E |
floor(E e) |
java.util.NavigableSet<E> |
headSet(E toElement,
boolean inclusive) |
E |
higher(E e) |
E |
lower(E e) |
E |
pollFirst() |
E |
pollLast() |
protected E |
standardCeiling(E e)
|
protected E |
standardFirst() |
protected E |
standardFloor(E e)
A sensible definition of
floor(E) in terms of the descendingIterator method of
headSet(Object, boolean) . |
protected java.util.SortedSet<E> |
standardHeadSet(E toElement)
A sensible definition of
ForwardingSortedSet.headSet(Object) in terms of the
headSet(Object, boolean) method. |
protected E |
standardHigher(E e)
|
protected E |
standardLast() |
protected E |
standardLower(E e)
A sensible definition of
lower(E) in terms of the descendingIterator method of
headSet(Object, boolean) . |
protected E |
standardPollFirst()
A sensible definition of
pollFirst() in terms of the iterator method. |
protected E |
standardPollLast()
A sensible definition of
pollLast() in terms of the descendingIterator method. |
protected java.util.NavigableSet<E> |
standardSubSet(E fromElement,
boolean fromInclusive,
E toElement,
boolean toInclusive)
A sensible definition of
subSet(Object, boolean, Object, boolean) in terms of the
headSet and tailSet methods. |
protected java.util.SortedSet<E> |
standardSubSet(E fromElement,
E toElement)
A sensible definition of
ForwardingSortedSet.subSet(Object, Object) in terms of the
subSet(Object, boolean, Object, boolean) method. |
protected java.util.SortedSet<E> |
standardTailSet(E fromElement)
A sensible definition of
ForwardingSortedSet.tailSet(Object) in terms of the
tailSet(Object, boolean) method. |
java.util.NavigableSet<E> |
subSet(E fromElement,
boolean fromInclusive,
E toElement,
boolean toInclusive) |
java.util.NavigableSet<E> |
tailSet(E fromElement,
boolean inclusive) |
comparator, first, headSet, last, standardContains, standardRemove, subSet, tailSet
equals, hashCode, standardEquals, standardHashCode, standardRemoveAll
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContainsAll, standardIsEmpty, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray
toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
protected ForwardingNavigableSet()
protected abstract java.util.NavigableSet<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.delegate
in class ForwardingSortedSet<E>
protected E standardLower(E e)
lower(E)
in terms of the descendingIterator
method of
headSet(Object, boolean)
. If you override headSet(Object, boolean)
, you may
wish to override lower(E)
to forward to this implementation.protected E standardFloor(E e)
floor(E)
in terms of the descendingIterator
method of
headSet(Object, boolean)
. If you override headSet(Object, boolean)
, you may
wish to override floor(E)
to forward to this implementation.protected E standardCeiling(E e)
ceiling(E)
in terms of the iterator
method of
tailSet(Object, boolean)
. If you override tailSet(Object, boolean)
, you may
wish to override ceiling(E)
to forward to this implementation.protected E standardHigher(E e)
higher(E)
in terms of the iterator
method of
tailSet(Object, boolean)
. If you override tailSet(Object, boolean)
, you may
wish to override higher(E)
to forward to this implementation.protected E standardPollFirst()
pollFirst()
in terms of the iterator
method. If you
override ForwardingCollection.iterator()
you may wish to override pollFirst()
to forward to this
implementation.protected E standardPollLast()
pollLast()
in terms of the descendingIterator
method.
If you override descendingIterator()
you may wish to override pollLast()
to
forward to this implementation.protected E standardFirst()
protected E standardLast()
public java.util.NavigableSet<E> descendingSet()
descendingSet
in interface java.util.NavigableSet<E>
public java.util.Iterator<E> descendingIterator()
descendingIterator
in interface java.util.NavigableSet<E>
public java.util.NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
subSet
in interface java.util.NavigableSet<E>
@Beta protected java.util.NavigableSet<E> standardSubSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
subSet(Object, boolean, Object, boolean)
in terms of the
headSet
and tailSet
methods. In many cases, you may wish to override
subSet(Object, boolean, Object, boolean)
to forward to this implementation.protected java.util.SortedSet<E> standardSubSet(E fromElement, E toElement)
ForwardingSortedSet.subSet(Object, Object)
in terms of the
subSet(Object, boolean, Object, boolean)
method. If you override
subSet(Object, boolean, Object, boolean)
, you may wish to override
ForwardingSortedSet.subSet(Object, Object)
to forward to this implementation.standardSubSet
in class ForwardingSortedSet<E>
public java.util.NavigableSet<E> headSet(E toElement, boolean inclusive)
headSet
in interface java.util.NavigableSet<E>
protected java.util.SortedSet<E> standardHeadSet(E toElement)
ForwardingSortedSet.headSet(Object)
in terms of the
headSet(Object, boolean)
method. If you override
headSet(Object, boolean)
, you may wish to override
ForwardingSortedSet.headSet(Object)
to forward to this implementation.public java.util.NavigableSet<E> tailSet(E fromElement, boolean inclusive)
tailSet
in interface java.util.NavigableSet<E>
protected java.util.SortedSet<E> standardTailSet(E fromElement)
ForwardingSortedSet.tailSet(Object)
in terms of the
tailSet(Object, boolean)
method. If you override
tailSet(Object, boolean)
, you may wish to override
ForwardingSortedSet.tailSet(Object)
to forward to this implementation.