Apache Commons Collections 4.4 · org.apache.commons.collections4.set.UnmodifiableNavigableSet

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.serialVersionUID. Serialization version

Access	Constructor and Description
private	UnmodifiableNavigableSet(final NavigableSet<E> the set to decorate, must not be null set) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
public boolean	add(final E element to be added to this set object) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this set if it is not already present (optional operation).
public boolean	addAll(final Collection<? extends E> collection containing elements to be added to this set coll) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.addAll. Implements java.util.Set.addAll, java.util.Collection.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
public void	clear() Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.clear. Implements java.util.Set.clear, java.util.Collection.clear. Removes all of the elements from this set (optional operation).
public Iterator<E>	descendingIterator() Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.descendingIterator. Implements java.util.NavigableSet.descendingIterator. Returns an iterator over the elements in this set, in descending order.
public NavigableSet<E>	descendingSet() Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.descendingSet. Implements java.util.NavigableSet.descendingSet. Returns a reverse order view of the elements contained in this set.
public SortedSet<E>	headSet(final E high endpoint (exclusive) of the returned set toElement) Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.headSet. Implements java.util.NavigableSet.headSet, java.util.SortedSet.headSet. Returns a view of the portion of this set whose elements are strictly less than `toElement`.
public NavigableSet<E>	headSet(final E high endpoint of the returned set toElement, final boolean `true` if the high endpoint is to be included in the returned view inclusive) Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.headSet. Implements java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement`.
public Iterator<E>	iterator() Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.iterator. Implements java.util.NavigableSet.iterator, java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set, in ascending order.
private void	readObject(final ObjectInputStream the input stream in) Read the collection in using a custom routine.
public boolean	remove(final Object object to be removed from this set, if present object) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.remove. Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present (optional operation).
public boolean	removeAll(final Collection<?> collection containing elements to be removed from this set coll) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeAll. Implements java.util.Set.removeAll, java.util.Collection.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public boolean	removeIf(Predicate<? super E> a predicate which returns `true` for elements to be removed filter) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeIf. Overrides default java.util.Collection.removeIf. Removes all of the elements of this collection that satisfy the given predicate.
public boolean	retainAll(final Collection<?> collection containing elements to be retained in this set coll) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.retainAll. Implements java.util.Set.retainAll, java.util.Collection.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public SortedSet<E>	subSet(final E low endpoint (inclusive) of the returned set fromElement, final E high endpoint (exclusive) of the returned set toElement) Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.subSet. Implements java.util.NavigableSet.subSet, java.util.SortedSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive.
public NavigableSet<E>	subSet(final E low endpoint of the returned set fromElement, final boolean `true` if the low endpoint is to be included in the returned view fromInclusive, final E high endpoint of the returned set toElement, final boolean `true` if the high endpoint is to be included in the returned view toInclusive) Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.subSet. Implements java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement` to `toElement`.
public SortedSet<E>	tailSet(final E low endpoint (inclusive) of the returned set fromElement) Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.tailSet. Implements java.util.NavigableSet.tailSet, java.util.SortedSet.tailSet. Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`.
public NavigableSet<E>	tailSet(final E low endpoint of the returned set fromElement, final boolean `true` if the low endpoint is to be included in the returned view inclusive) Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.tailSet. Implements java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than (or equal to, if `inclusive` is true) `fromElement`.
public static < the element type E> NavigableSet<E>	Returns: a new unmodifiable `NavigableSet` unmodifiableNavigableSet(final NavigableSet<E> the set to decorate, must not be null set) Factory method to create an unmodifiable set.
private void	writeObject(final ObjectOutputStream the output stream out) Write the collection out using a custom routine.

Inherited from org.apache.commons.collections4.set.AbstractNavigableSetDecorator:: ceiling decorated floor higher lower pollFirst pollLast

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.serialVersionUID. Serialization version

UnmodifiableNavigableSet	back to summary
private UnmodifiableNavigableSet(final NavigableSet<E> set) Constructor that wraps (not copies). Parameters set:NavigableSet<E> the set to decorate, must not be null Exceptions NullPointerException: if set is null

Method Detail

add back to summary

add	back to summary
public boolean add(final E object) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.add. Implements java.util.Set.add, java.util.Collection.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain. Parameters object:E element to be added to this set Returns:boolean `true` if this set did not already contain the specified element Annotations @Override

public boolean add(final E object)

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.add.

Implements java.util.Set.add, java.util.Collection.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters

object:E: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(final Collection<? extends E> coll) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.addAll. Implements java.util.Set.addAll, java.util.Collection.addAll. Doc from java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the `addAll` operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. Parameters coll:Collection<? extends E> collection containing elements to be added to this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean addAll(final Collection<? extends E> coll)

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.addAll.

Implements java.util.Set.addAll, java.util.Collection.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters

coll:Collection<? extends E>: collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

clear	back to summary
public void clear() Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.clear. Implements java.util.Set.clear, java.util.Collection.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.clear.

Implements java.util.Set.clear, java.util.Collection.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Annotations

@Override

descendingIterator back to summary

descendingIterator	back to summary
public Iterator<E> descendingIterator() Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.descendingIterator. Implements java.util.NavigableSet.descendingIterator. Doc from java.util.NavigableSet.descendingIterator. Returns an iterator over the elements in this set, in descending order. Equivalent in effect to `descendingSet().iterator()`. Returns:Iterator<E> an iterator over the elements in this set, in descending order Annotations @Override

public Iterator<E> descendingIterator()

Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.descendingIterator.

Implements java.util.NavigableSet.descendingIterator.

Doc from java.util.NavigableSet.descendingIterator.

Returns an iterator over the elements in this set, in descending order. Equivalent in effect to descendingSet().iterator().

Returns:Iterator<E>

an iterator over the elements in this set, in descending order

Annotations

@Override

descendingSet back to summary

descendingSet	back to summary
public NavigableSet<E> descendingSet() Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.descendingSet. Implements java.util.NavigableSet.descendingSet. Doc from java.util.NavigableSet.descendingSet. Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. If either set is modified while an iteration over either set is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The returned set has an ordering equivalent to `Collections.reverseOrder(comparator())`. The expression `s.descendingSet().descendingSet()` returns a view of `s` essentially equivalent to `s`. Returns:NavigableSet<E> a reverse order view of this set Annotations @Override

public NavigableSet<E> descendingSet()

Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.descendingSet.

Implements java.util.NavigableSet.descendingSet.

Doc from java.util.NavigableSet.descendingSet.

Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. If either set is modified while an iteration over either set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

The returned set has an ordering equivalent to Collections.reverseOrder(comparator()). The expression s.descendingSet().descendingSet() returns a view of s essentially equivalent to s.

Returns:NavigableSet<E>

a reverse order view of this set

Annotations

@Override

headSet back to summary

headSet	back to summary
public SortedSet<E> headSet(final E toElement) Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.headSet. Implements java.util.NavigableSet.headSet, java.util.SortedSet.headSet. Doc from java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are strictly less than `toElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `headSet(toElement, false)`. Parameters toElement:E Doc from java.util.SortedSet.headSet. high endpoint (exclusive) of the returned set Returns:SortedSet<E> Doc from java.util.SortedSet.headSet. a view of the portion of this set whose elements are strictly less than `toElement` Annotations @Override

public SortedSet<E> headSet(final E toElement)

Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.headSet.

Implements java.util.NavigableSet.headSet, java.util.SortedSet.headSet.

Doc from java.util.NavigableSet.headSet.

Returns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Equivalent to headSet(toElement, false).

Parameters

toElement:E

Doc from java.util.SortedSet.headSet.

high endpoint (exclusive) of the returned set

Returns:SortedSet<E>

Doc from java.util.SortedSet.headSet.

a view of the portion of this set whose elements are strictly less than toElement

Annotations

@Override

headSet back to summary

headSet	back to summary
public NavigableSet<E> headSet(final E toElement, final boolean inclusive) Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.headSet. Implements java.util.NavigableSet.headSet. Doc from java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Parameters toElement:E high endpoint of the returned set inclusive:boolean `true` if the high endpoint is to be included in the returned view Returns:NavigableSet<E> a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement` Annotations @Override

public NavigableSet<E> headSet(final E toElement, final boolean inclusive)

Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.headSet.

Implements java.util.NavigableSet.headSet.

Doc from java.util.NavigableSet.headSet.

Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters

toElement:E: high endpoint of the returned set
inclusive:boolean: true if the high endpoint is to be included in the returned view

Returns:NavigableSet<E>

a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement

Annotations

@Override

iterator	back to summary
public Iterator<E> iterator() Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.iterator. Implements java.util.NavigableSet.iterator, java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.NavigableSet.iterator. Returns an iterator over the elements in this set, in ascending order. Returns:Iterator<E> an iterator over the elements in this set, in ascending order Annotations @Override

iterator

back to summary

public Iterator<E> iterator()

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.iterator.

Implements java.util.NavigableSet.iterator, java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.NavigableSet.iterator.

Returns an iterator over the elements in this set, in ascending order.

Returns:Iterator<E>

an iterator over the elements in this set, in ascending order

Annotations

@Override

readObject	back to summary
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException Read the collection in using a custom routine. Parameters in:ObjectInputStream the input stream Annotations @SuppressWarnings:unchecked Exceptions IOException: if an error occurs while reading from the stream ClassNotFoundException: if an object read from the stream can not be loaded

readObject

back to summary

private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException

Read the collection in using a custom routine.

Parameters

in:ObjectInputStream: the input stream

Annotations

@SuppressWarnings:unchecked

Exceptions

IOException:: if an error occurs while reading from the stream
ClassNotFoundException:: if an object read from the stream can not be loaded

remove back to summary

remove	back to summary
public boolean remove(final Object object) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.remove. Implements java.util.Set.remove, java.util.Collection.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters object:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element Annotations @Override

public boolean remove(final Object object)

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.remove.

Implements java.util.Set.remove, java.util.Collection.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

object:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(final Collection<?> coll) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeAll. Implements java.util.Set.removeAll, java.util.Collection.removeAll. Doc from java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets. Parameters coll:Collection<?> collection containing elements to be removed from this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean removeAll(final Collection<?> coll)

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeAll.

Implements java.util.Set.removeAll, java.util.Collection.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters

coll:Collection<?>: collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

removeIf back to summary

removeIf	back to summary
public boolean removeIf(Predicate<? super E> filter) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeIf. Overrides default java.util.Collection.removeIf. Doc from java.util.Collection.removeIf. Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller. Parameters filter:Predicate<? super E> a predicate which returns `true` for elements to be removed Returns:boolean `true` if any elements were removed Annotations @Override Since 4.4

public boolean removeIf(Predicate<? super E> filter)

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeIf.

Overrides default java.util.Collection.removeIf.

Doc from java.util.Collection.removeIf.

Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.

Parameters

filter:Predicate<? super E>: a predicate which returns true for elements to be removed

Returns:boolean

true if any elements were removed

Annotations

@Override

Since

4.4

retainAll back to summary

retainAll	back to summary
public boolean retainAll(final Collection<?> coll) Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.retainAll. Implements java.util.Set.retainAll, java.util.Collection.retainAll. Doc from java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets. Parameters coll:Collection<?> collection containing elements to be retained in this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean retainAll(final Collection<?> coll)

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.retainAll.

Implements java.util.Set.retainAll, java.util.Collection.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters

coll:Collection<?>: collection containing elements to be retained in this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

subSet back to summary

subSet	back to summary
public SortedSet<E> subSet(final E fromElement, final E toElement) Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.subSet. Implements java.util.NavigableSet.subSet, java.util.SortedSet.subSet. Doc from java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive. (If `fromElement` and `toElement` are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `subSet(fromElement, true, toElement, false)`. Parameters fromElement:E Doc from java.util.SortedSet.subSet. low endpoint (inclusive) of the returned set toElement:E Doc from java.util.SortedSet.subSet. high endpoint (exclusive) of the returned set Returns:SortedSet<E> Doc from java.util.SortedSet.subSet. a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive Annotations @Override

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

Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.subSet.

Implements java.util.NavigableSet.subSet, java.util.SortedSet.subSet.

Doc from java.util.NavigableSet.subSet.

Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Equivalent to subSet(fromElement, true, toElement, false).

Parameters

fromElement:E

Doc from java.util.SortedSet.subSet.

low endpoint (inclusive) of the returned set

toElement:E

Doc from java.util.SortedSet.subSet.

high endpoint (exclusive) of the returned set

Returns:SortedSet<E>

Doc from java.util.SortedSet.subSet.

a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

Annotations

@Override

subSet back to summary

subSet	back to summary
public NavigableSet<E> subSet(final E fromElement, final boolean fromInclusive, final E toElement, final boolean toInclusive) Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.subSet. Implements java.util.NavigableSet.subSet. Doc from java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement` to `toElement`. If `fromElement` and `toElement` are equal, the returned set is empty unless `fromInclusive` and `toInclusive` are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Parameters fromElement:E low endpoint of the returned set fromInclusive:boolean `true` if the low endpoint is to be included in the returned view toElement:E high endpoint of the returned set toInclusive:boolean `true` if the high endpoint is to be included in the returned view Returns:NavigableSet<E> a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive Annotations @Override

public NavigableSet<E> subSet(final E fromElement, final boolean fromInclusive, final E toElement, final boolean toInclusive)

Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.subSet.

Implements java.util.NavigableSet.subSet.

Doc from java.util.NavigableSet.subSet.

Returns a view of the portion of this set whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned set is empty unless fromInclusive and toInclusive are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters

fromElement:E: low endpoint of the returned set
fromInclusive:boolean: true if the low endpoint is to be included in the returned view
toElement:E: high endpoint of the returned set
toInclusive:boolean: true if the high endpoint is to be included in the returned view

Returns:NavigableSet<E>

a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

Annotations

@Override

tailSet back to summary

tailSet	back to summary
public SortedSet<E> tailSet(final E fromElement) Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.tailSet. Implements java.util.NavigableSet.tailSet, java.util.SortedSet.tailSet. Doc from java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `tailSet(fromElement, true)`. Parameters fromElement:E Doc from java.util.SortedSet.tailSet. low endpoint (inclusive) of the returned set Returns:SortedSet<E> Doc from java.util.SortedSet.tailSet. a view of the portion of this set whose elements are greater than or equal to `fromElement` Annotations @Override

public SortedSet<E> tailSet(final E fromElement)

Overrides org.apache.commons.collections4.set.AbstractSortedSetDecorator.tailSet.

Implements java.util.NavigableSet.tailSet, java.util.SortedSet.tailSet.

Doc from java.util.NavigableSet.tailSet.

Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Equivalent to tailSet(fromElement, true).

Parameters

fromElement:E

Doc from java.util.SortedSet.tailSet.

low endpoint (inclusive) of the returned set

Returns:SortedSet<E>

Doc from java.util.SortedSet.tailSet.

a view of the portion of this set whose elements are greater than or equal to fromElement

Annotations

@Override

tailSet back to summary

tailSet	back to summary
public NavigableSet<E> tailSet(final E fromElement, final boolean inclusive) Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.tailSet. Implements java.util.NavigableSet.tailSet. Doc from java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than (or equal to, if `inclusive` is true) `fromElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Parameters fromElement:E low endpoint of the returned set inclusive:boolean `true` if the low endpoint is to be included in the returned view Returns:NavigableSet<E> a view of the portion of this set whose elements are greater than or equal to `fromElement` Annotations @Override

public NavigableSet<E> tailSet(final E fromElement, final boolean inclusive)

Overrides org.apache.commons.collections4.set.AbstractNavigableSetDecorator.tailSet.

Implements java.util.NavigableSet.tailSet.

Doc from java.util.NavigableSet.tailSet.

Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters

fromElement:E: low endpoint of the returned set
inclusive:boolean: true if the low endpoint is to be included in the returned view

Returns:NavigableSet<E>

a view of the portion of this set whose elements are greater than or equal to fromElement

Annotations

@Override

unmodifiableNavigableSet back to summary

unmodifiableNavigableSet	back to summary
public static <E> NavigableSet<E> unmodifiableNavigableSet(final NavigableSet<E> set) Factory method to create an unmodifiable set. Parameters <E> the element type set:NavigableSet<E> the set to decorate, must not be null Returns:NavigableSet<E> a new unmodifiable `NavigableSet` Exceptions NullPointerException: if set is null

public static <E> NavigableSet<E> unmodifiableNavigableSet(final NavigableSet<E> set)

Factory method to create an unmodifiable set.

Parameters

<E>: the element type
set:NavigableSet<E>: the set to decorate, must not be null

Returns:NavigableSet<E>

a new unmodifiable NavigableSet

Exceptions

NullPointerException:: if set is null

writeObject	back to summary
private void writeObject(final ObjectOutputStream out) throws IOException Write the collection out using a custom routine. Parameters out:ObjectOutputStream the output stream Exceptions IOException: if an error occurs while writing to the stream

writeObject

back to summary

private void writeObject(final ObjectOutputStream out) throws IOException

Write the collection out using a custom routine.

Parameters

out:ObjectOutputStream: the output stream

Exceptions

IOException:: if an error occurs while writing to the stream

public final Class UnmodifiableNavigableSet<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail