@GwtCompatible public abstract class ForwardingSortedSet<E> extends ForwardingSet<E> implements java.util.SortedSet<E>
Warning: The methods of ForwardingSortedSet
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.
default
method warning: This class does not forward calls to default
methods. Instead, it inherits their default implementations. When those implementations
invoke methods, they invoke methods on the ForwardingSortedSet
.
Each of the standard
methods, where appropriate, 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 | Constructor and Description |
---|---|
protected |
ForwardingSortedSet()
Constructor for use by subclasses.
|
Modifier and Type | Method and Description |
---|---|
java.util.Comparator<? super E> |
comparator()
Returns the comparator used to order the elements in this set,
or null if this set uses the natural ordering of its elements.
|
protected abstract java.util.SortedSet<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
E |
first()
Returns the first (lowest) element currently in this set.
|
java.util.SortedSet<E> |
headSet(E toElement)
Returns a view of the portion of this set whose elements are
strictly less than toElement.
|
E |
last()
Returns the last (highest) element currently in this set.
|
protected boolean |
standardContains(java.lang.Object object)
A sensible definition of
ForwardingCollection.contains(java.lang.Object) in terms of the first() method of tailSet(E) . |
protected boolean |
standardRemove(java.lang.Object object)
A sensible definition of
ForwardingCollection.remove(java.lang.Object) in terms of the iterator() method of tailSet(E) . |
protected java.util.SortedSet<E> |
standardSubSet(E fromElement,
E toElement)
A sensible default implementation of
subSet(Object, Object) in terms of headSet(Object) and tailSet(Object) . |
java.util.SortedSet<E> |
subSet(E fromElement,
E toElement)
Returns a view of the portion of this set whose elements range
from fromElement, inclusive, to toElement,
exclusive.
|
java.util.SortedSet<E> |
tailSet(E fromElement)
Returns a view of the portion of this set whose elements are
greater than or equal to fromElement.
|
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 ForwardingSortedSet()
protected abstract java.util.SortedSet<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply the
instance being decorated.delegate
in class ForwardingSet<E>
public java.util.Comparator<? super E> comparator()
java.util.SortedSet
comparator
in interface java.util.SortedSet<E>
public E first()
java.util.SortedSet
first
in interface java.util.SortedSet<E>
public java.util.SortedSet<E> headSet(E toElement)
java.util.SortedSet
The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
headSet
in interface java.util.SortedSet<E>
toElement
- high endpoint (exclusive) of the returned setpublic E last()
java.util.SortedSet
last
in interface java.util.SortedSet<E>
public java.util.SortedSet<E> subSet(E fromElement, E toElement)
java.util.SortedSet
The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
subSet
in interface java.util.SortedSet<E>
fromElement
- low endpoint (inclusive) of the returned settoElement
- high endpoint (exclusive) of the returned setpublic java.util.SortedSet<E> tailSet(E fromElement)
java.util.SortedSet
The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
tailSet
in interface java.util.SortedSet<E>
fromElement
- low endpoint (inclusive) of the returned set@Beta protected boolean standardContains(@NullableDecl java.lang.Object object)
ForwardingCollection.contains(java.lang.Object)
in terms of the first()
method of tailSet(E)
. If you override tailSet(E)
, you may wish to override ForwardingCollection.contains(java.lang.Object)
to
forward to this implementation.standardContains
in class ForwardingCollection<E>
@Beta protected boolean standardRemove(@NullableDecl java.lang.Object object)
ForwardingCollection.remove(java.lang.Object)
in terms of the iterator()
method of tailSet(E)
. If you override tailSet(E)
, you may wish to override ForwardingCollection.remove(java.lang.Object)
to
forward to this implementation.standardRemove
in class ForwardingCollection<E>
@Beta protected java.util.SortedSet<E> standardSubSet(E fromElement, E toElement)
subSet(Object, Object)
in terms of headSet(Object)
and tailSet(Object)
. In some situations, you may wish to override
subSet(Object, Object)
to forward to this implementation.Copyright © 2010–2019 JBoss by Red Hat. All rights reserved.