Class PredicatedSet

  • All Implemented Interfaces:
    Serializable, Iterable, Collection, Set
    Direct Known Subclasses:

    public class PredicatedSet
    extends PredicatedCollection
    implements Set
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    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.

    Commons Collections 3.0
    See Also:
    Serialized Form
    • Method Detail

      • decorate

        public static Set decorate​(Set set,
                                   Predicate predicate)
        Factory method to create a predicated (validating) set.

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

        set - the set to decorate, must not be null
        predicate - the predicate to use for validation, must not be null
        IllegalArgumentException - if set or predicate is null
        IllegalArgumentException - if the set contains invalid elements