org.apache.commons.collections.set

Class CompositeSet

public class CompositeSet extends CompositeCollection implements Set

Decorates a set of other sets to provide a single unified view.

Changes made to this set will actually be made on the decorated set. Add operations require the use of a pluggable strategy. If no strategy is provided then add is unsupported.

Since: Commons Collections 3.0

Version: $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author: Brian McCallister

Nested Class Summary
static interface	CompositeSet.SetMutator Define callbacks for mutation operations.

Constructor Summary
	CompositeSet() Create an empty CompositeSet
	CompositeSet(Set set) Create a CompositeSet with just `set` composited
	CompositeSet(Set[] sets) Create a composite set with sets as the initial set of composited Sets

Method Summary
void	addComposited(Collection c) Add a Set to this composite
void	addComposited(Collection c, Collection d) Add two sets to this composite
void	addComposited(Collection[] comps) Add an array of sets to this composite
boolean	equals(Object obj)
int	hashCode()
boolean	remove(Object obj) If a `CollectionMutator` is defined for this CompositeSet then this method will be called anyway.
void	setMutator(CollectionMutator mutator) This can receive either a `CompositeCollection.CollectionMutator` or a `CompositeSet.SetMutator`.

Constructor Detail

CompositeSet

public CompositeSet()

Create an empty CompositeSet

CompositeSet

public CompositeSet(Set set)

Create a CompositeSet with just set composited

Parameters: set The initial set in the composite

CompositeSet

public CompositeSet(Set[] sets)

Create a composite set with sets as the initial set of composited Sets

Method Detail

addComposited

public void addComposited(Collection c)

Add a Set to this composite

Parameters: c Must implement Set

Throws: IllegalArgumentException if c does not implement java.util.Set or if a SetMutator is set, but fails to resolve a collision UnsupportedOperationException if there is no SetMutator set, or a CollectionMutator is set instead of a SetMutator

addComposited

public void addComposited(Collection c, Collection d)

Add two sets to this composite

Throws: IllegalArgumentException if c or d does not implement java.util.Set

addComposited

public void addComposited(Collection[] comps)

Add an array of sets to this composite

Parameters: comps

Throws: IllegalArgumentException if any of the collections in comps do not implement Set

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

remove

public boolean remove(Object obj)

If a CollectionMutator is defined for this CompositeSet then this method will be called anyway.

Parameters: obj Object to be removed

Returns: true if the object is removed, false otherwise

setMutator

public void setMutator(CollectionMutator mutator)

This can receive either a CompositeCollection.CollectionMutator or a CompositeSet.SetMutator. If a CompositeCollection.CollectionMutator is used than conflicts when adding composited sets will throw IllegalArgumentException