Class PredicatedSet<E>

  • Type Parameters:
    E - the type of the elements in this set
    All Implemented Interfaces:, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>
    Direct Known Subclasses:

    public class PredicatedSet<E>
    extends PredicatedCollection<E>
    implements java.util.Set<E>
    Decorates another Set 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.

    Set set = PredicatedSet.decorate(new HashSet(), NotNullPredicate.INSTANCE);

    This class is Serializable from Commons Collections 3.1.

    See Also:
    Serialized Form
    • Method Detail

      • predicatedSet

        public static <E> PredicatedSet<E> predicatedSet​(java.util.Set<E> set,
                                                         Predicate<? super E> predicate)
        Factory method to create a predicated (validating) set.

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

        Type Parameters:
        E - the element type
        set - the set to decorate, must not be null
        predicate - the predicate to use for validation, must not be null
        a decorated set
        java.lang.NullPointerException - if set or predicate is null
        java.lang.IllegalArgumentException - if the set contains invalid elements
      • equals

        public boolean equals​(java.lang.Object object)
        Specified by:
        equals in interface java.util.Collection<E>
        Specified by:
        equals in interface java.util.Set<E>
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Collection<E>
        Specified by:
        hashCode in interface java.util.Set<E>
        hashCode in class java.lang.Object