Package org.apache.commons.collections.set

Class PredicatedSortedSet

java.lang.Object

org.apache.commons.collections.collection.AbstractCollectionDecorator

org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator

org.apache.commons.collections.collection.PredicatedCollection

org.apache.commons.collections.set.PredicatedSet

org.apache.commons.collections.set.PredicatedSortedSet

All Implemented Interfaces:

Serializable, Iterable, Collection, Set, SortedSet

@Deprecated(since="2021-04-30")
public class PredicatedSortedSet
extends PredicatedSet
implements SortedSet

Deprecated.

Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.

Decorates another SortedSet to validate that all additions match a specified predicate.

This set exists to provide validation for the decorated set. It is normally created to decorate an empty set. If an object cannot be added to the set, an IllegalArgumentException is thrown.

One usage would be to ensure that no null entries are added to the set.

SortedSet set = PredicatedSortedSet.decorate(new TreeSet(), NotNullPredicate.INSTANCE);

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
Comparator	comparator()	Deprecated.
static SortedSet	decorate(SortedSet set, Predicate predicate)	Deprecated. Factory method to create a predicated (validating) sorted set.
Object	first()	Deprecated.
SortedSet	headSet(Object toElement)	Deprecated.
Object	last()	Deprecated.
SortedSet	subSet(Object fromElement, Object toElement)	Deprecated.
SortedSet	tailSet(Object fromElement)	Deprecated.

Methods inherited from class org.apache.commons.collections.set.PredicatedSet

decorate

Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection

add, addAll, decorate

Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.SortedSet

spliterator

Method Detail

decorate

public static SortedSet decorate(SortedSet set,
                                 Predicate predicate)

Deprecated.

Factory method to create a predicated (validating) sorted set.

If there are any elements already in the set being decorated, they are validated.

Parameters:

set - the set to decorate, must not be null

predicate - the predicate to use for validation, must not be null

Throws:

IllegalArgumentException - if set or predicate is null

IllegalArgumentException - if the set contains invalid elements

subSet

public SortedSet subSet(Object fromElement,
                        Object toElement)

Deprecated.

Specified by:

subSet in interface SortedSet

headSet

public SortedSet headSet(Object toElement)

Deprecated.

Specified by:

headSet in interface SortedSet

tailSet

public SortedSet tailSet(Object fromElement)

Deprecated.

Specified by:

tailSet in interface SortedSet

first

public Object first()

Deprecated.

Specified by:

first in interface SortedSet

last

public Object last()

Deprecated.

Specified by:

last in interface SortedSet

comparator

public Comparator comparator()

Deprecated.

Specified by:

comparator in interface SortedSet