org.jboss.util.collection
Class ListSet

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractSet
          org.jboss.util.collection.ListSet

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, java.io.Serializable, java.util.Set

public class ListSet

extends java.util.AbstractSet

implements java.util.Set, java.lang.Cloneable, java.io.Serializable

A thin wrapper around a List transforming it into a modifiable Set.

See Also:

Serialized Form

list

protected final java.util.List list

The List which will be used for element storage.

ListSet

public ListSet(java.util.List list)

Construct a ListSet.

Parameters:

list - The List which will be used for element storage.

Throws:

java.lang.IllegalArgumentException - List is null or contains duplicate entries.

ListSet

public ListSet()

Construct a ListSet using an ArrayList for backing.

ListSet

public ListSet(java.util.Collection elements)

Construct a ListSet using an ArrayList for backing and populated with the given elements.

Parameters:

elements - The elements for the list.

getList

public java.util.List getList()

size

public int size()

Return the size of the set.

Specified by:

size in interface java.util.Set

Returns:

The size of the set.

iterator

public java.util.Iterator iterator()

Return an iteration over the elements in the set.

Specified by:

iterator in interface java.util.Set

Returns:

An iteration over the elements in the set.

add

public boolean add(java.lang.Object obj)

Add an element to the set.

Specified by:

add in interface java.util.Set

Parameters:

obj - Element to add to the set.

Returns:

True if the element was added.

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

isEmpty in interface java.util.Set

Returns:

true if this set contains no elements.

contains

public boolean contains(java.lang.Object obj)

Returns true if this set contains the specified element.

Specified by:

contains in interface java.util.Set

Parameters:

obj - Element whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

remove

public boolean remove(java.lang.Object obj)

Removes the given element from this set if it is present.

Specified by:

remove in interface java.util.Set

Parameters:

obj - Object to be removed from this set, if present.

Returns:

true if the set contained the specified element.

clear

public void clear()

Removes all of the elements from this set.

Specified by:

clear in interface java.util.Set

clone

public java.lang.Object clone()

Returns a shallow copy of this ListSet instance.

Returns:

A shallow copy of this set.