public static interface

CompositeCollection.CollectionMutator

org.apache.commons.collections.collection.CompositeCollection.CollectionMutator
Known Indirect Subclasses

Class Overview

Pluggable strategy to handle changes to the composite.

Summary

Public Methods
abstract boolean add(CompositeCollection composite, Collection[] collections, Object obj)
Called when an object is to be added to the composite.
abstract boolean addAll(CompositeCollection composite, Collection[] collections, Collection coll)
Called when a collection is to be added to the composite.
abstract boolean remove(CompositeCollection composite, Collection[] collections, Object obj)
Called when an object is to be removed to the composite.

Public Methods

public abstract boolean add (CompositeCollection composite, Collection[] collections, Object obj)

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
UnsupportedOperationException if add is unsupported
ClassCastException if the object cannot be added due to its type
NullPointerException if the object cannot be added because its null
IllegalArgumentException if the object cannot be added

public abstract boolean addAll (CompositeCollection composite, Collection[] collections, Collection coll)

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
UnsupportedOperationException if add is unsupported
ClassCastException if the object cannot be added due to its type
NullPointerException if the object cannot be added because its null
IllegalArgumentException if the object cannot be added

public abstract boolean remove (CompositeCollection composite, Collection[] collections, Object obj)

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
UnsupportedOperationException if removed is unsupported
ClassCastException if the object cannot be removed due to its type
NullPointerException if the object cannot be removed because its null
IllegalArgumentException if the object cannot be removed