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
    Version:
    $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
    See Also:
    Serialized Form

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Serialization version
        See Also:
        Constant Field Values

    • Constructor Detail

      • PredicatedSortedSet

        protected PredicatedSortedSet​(java.util.SortedSet set,
                              Predicate predicate)
        Constructor that wraps (not copies).

        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

    • 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

      • getSortedSet

        private java.util.SortedSet getSortedSet()
        Gets the sorted set being decorated.
        Returns:
        the decorated sorted set

      • 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