Package org.apache.commons.collections.collection

Interface CompositeCollection.CollectionMutator

All Known Subinterfaces:

CompositeSet.SetMutator

Enclosing class:

CompositeCollection

@Deprecated(since="2021-04-30")
public static interface CompositeCollection.CollectionMutator

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.

Pluggable strategy to handle changes to the composite.

Method Summary

Modifier and Type	Method	Description
boolean	add(CompositeCollection composite, java.util.Collection[] collections, java.lang.Object obj)	Deprecated. Called when an object is to be added to the composite.
boolean	addAll(CompositeCollection composite, java.util.Collection[] collections, java.util.Collection coll)	Deprecated. Called when a collection is to be added to the composite.
boolean	remove(CompositeCollection composite, java.util.Collection[] collections, java.lang.Object obj)	Deprecated. Called when an object is to be removed to the composite.

Method Detail

add

boolean add(CompositeCollection composite,
            java.util.Collection[] collections,
            java.lang.Object obj)

Deprecated.

Called when an object is to be added to the composite.

Parameters:

composite - the CompositeCollection being changed

collections - all of the Collection instances in this CompositeCollection

obj - the object being added

Returns:

true if the collection is changed

Throws:

java.lang.UnsupportedOperationException - if add is unsupported

java.lang.ClassCastException - if the object cannot be added due to its type

java.lang.NullPointerException - if the object cannot be added because its null

java.lang.IllegalArgumentException - if the object cannot be added

addAll

boolean addAll(CompositeCollection composite,
               java.util.Collection[] collections,
               java.util.Collection coll)

Deprecated.

Called when a collection is to be added to the composite.

Parameters:

composite - the CompositeCollection being changed

collections - all of the Collection instances in this CompositeCollection

coll - the collection being added

Returns:

true if the collection is changed

Throws:

java.lang.UnsupportedOperationException - if add is unsupported

java.lang.ClassCastException - if the object cannot be added due to its type

java.lang.NullPointerException - if the object cannot be added because its null

java.lang.IllegalArgumentException - if the object cannot be added

remove

boolean remove(CompositeCollection composite,
               java.util.Collection[] collections,
               java.lang.Object obj)

Deprecated.

Called when an object is to be removed to the composite.

Parameters:

composite - the CompositeCollection being changed

collections - all of the Collection instances in this CompositeCollection

obj - the object being removed

Returns:

true if the collection is changed

Throws:

java.lang.UnsupportedOperationException - if removed is unsupported

java.lang.ClassCastException - if the object cannot be removed due to its type

java.lang.NullPointerException - if the object cannot be removed because its null

java.lang.IllegalArgumentException - if the object cannot be removed