Package org.apache.commons.collections.set

Class PredicatedSortedSet

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.Set, java.util.SortedSet
    public class PredicatedSortedSet
extends PredicatedSet
implements java.util.SortedSet
    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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Comparator comparator()  
      static java.util.SortedSet decorate​(java.util.SortedSet set, Predicate predicate)
      Factory method to create a predicated (validating) sorted set.
      java.lang.Object first()  
      java.util.SortedSet headSet​(java.lang.Object toElement)  
      java.lang.Object last()  
      java.util.SortedSet subSet​(java.lang.Object fromElement, java.lang.Object toElement)  
      java.util.SortedSet tailSet​(java.lang.Object fromElement)  

      • 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 java.util.SortedSet decorate​(java.util.SortedSet set,
                                           Predicate predicate)
        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:
        java.lang.IllegalArgumentException - if set or predicate is null
        java.lang.IllegalArgumentException - if the set contains invalid elements

      • subSet

        public java.util.SortedSet subSet​(java.lang.Object fromElement,
                                  java.lang.Object toElement)
        Specified by:
        subSet in interface java.util.SortedSet

      • headSet

        public java.util.SortedSet headSet​(java.lang.Object toElement)
        Specified by:
        headSet in interface java.util.SortedSet

      • tailSet

        public java.util.SortedSet tailSet​(java.lang.Object fromElement)
        Specified by:
        tailSet in interface java.util.SortedSet

      • first

        public java.lang.Object first()
        Specified by:
        first in interface java.util.SortedSet

      • last

        public java.lang.Object last()
        Specified by:
        last in interface java.util.SortedSet

      • comparator

        public java.util.Comparator comparator()
        Specified by:
        comparator in interface java.util.SortedSet