Package org.apache.commons.collections.collection

Class PredicatedCollection

java.lang.Object
org.apache.commons.collections.collection.AbstractCollectionDecorator
org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
org.apache.commons.collections.collection.PredicatedCollection
All Implemented Interfaces:
Serializable, Iterable, Collection
Direct Known Subclasses:
PredicatedBag, PredicatedBuffer, PredicatedList, PredicatedSet
@Deprecated(since="2021-04-30") public class PredicatedCollection extends AbstractSerializableCollectionDecorator
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
Decorates another Collection to validate that additions match a specified predicate.

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

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

Collection coll = PredicatedCollection.decorate(new ArrayList(), NotNullPredicate.INSTANCE);

This class is Serializable from Commons Collections 3.1.

Since:
Commons Collections 3.0
See Also:

  • Method Details

    • decorate

      public static Collection decorate(Collection coll, Predicate predicate)
      Deprecated.
      Factory method to create a predicated (validating) collection.

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

      Parameters:
      coll - the collection to decorate, must not be null
      predicate - the predicate to use for validation, must not be null
      Returns:
      a new predicated collection
      Throws:
      IllegalArgumentException - if collection or predicate is null
      IllegalArgumentException - if the collection contains invalid elements

    • add

      public boolean add(Object object)
      Deprecated.
      Override to validate the object being added to ensure it matches the predicate.
      Specified by:
      add in interface Collection
      Overrides:
      add in class AbstractCollectionDecorator
      Parameters:
      object - the object being added
      Returns:
      the result of adding to the underlying collection
      Throws:
      IllegalArgumentException - if the add is invalid

    • addAll

      public boolean addAll(Collection coll)
      Deprecated.
      Override to validate the objects being added to ensure they match the predicate. If any one fails, no update is made to the underlying collection.
      Specified by:
      addAll in interface Collection
      Overrides:
      addAll in class AbstractCollectionDecorator
      Parameters:
      coll - the collection being added
      Returns:
      the result of adding to the underlying collection
      Throws:
      IllegalArgumentException - if the add is invalid