org.apache.commons.collections.collection

Interface CompositeCollection.CollectionMutator

public interface CompositeCollection.CollectionMutator

Pluggable strategy to handle changes to the composite.
Method Summary
booleanadd(CompositeCollection composite, Collection[] collections, Object obj)
Called when an object is to be added to the composite.
booleanaddAll(CompositeCollection composite, Collection[] collections, Collection coll)
Called when a collection is to be added to the composite.
booleanremove(CompositeCollection composite, Collection[] collections, Object obj)
Called when an object is to be removed to the composite.

Method Detail

add

public 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

addAll

public 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

remove

public 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

Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.