Package org.jboss.util.collection
Class ListSet
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractSet
-
- org.jboss.util.collection.ListSet
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Iterable
,java.util.Collection
,java.util.Set
public class ListSet extends java.util.AbstractSet implements java.util.Set, java.lang.Cloneable, java.io.Serializable
A thin wrapper around aList
transforming it into a modifiableSet
.- Version:
- $Revision$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List
list
The List which will be used for element storage.private static long
serialVersionUID
The serialVersionUID
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(java.lang.Object obj)
Add an element to the set.void
clear()
Removes all of the elements from this set.java.lang.Object
clone()
Returns a shallow copy of this ListSet instance.boolean
contains(java.lang.Object obj)
Returns true if this set contains the specified element.java.util.List
getList()
boolean
isEmpty()
Returns true if this set contains no elements.java.util.Iterator
iterator()
Return an iteration over the elements in the set.boolean
remove(java.lang.Object obj)
Removes the given element from this set if it is present.int
size()
Return the size of the set.-
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, retainAll, toArray, toArray, toString
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
The serialVersionUID- See Also:
- Constant Field Values
-
list
protected final java.util.List list
The List which will be used for element storage.
-
-
Constructor Detail
-
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.
-
-
Method Detail
-
getList
public java.util.List getList()
-
size
public int size()
Return the size of the set.- Specified by:
size
in interfacejava.util.Collection
- Specified by:
size
in interfacejava.util.Set
- Specified by:
size
in classjava.util.AbstractCollection
- 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 interfacejava.util.Collection
- Specified by:
iterator
in interfacejava.lang.Iterable
- Specified by:
iterator
in interfacejava.util.Set
- Specified by:
iterator
in classjava.util.AbstractCollection
- 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 interfacejava.util.Collection
- Specified by:
add
in interfacejava.util.Set
- Overrides:
add
in classjava.util.AbstractCollection
- 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 interfacejava.util.Collection
- Specified by:
isEmpty
in interfacejava.util.Set
- Overrides:
isEmpty
in classjava.util.AbstractCollection
- 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 interfacejava.util.Collection
- Specified by:
contains
in interfacejava.util.Set
- Overrides:
contains
in classjava.util.AbstractCollection
- 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 interfacejava.util.Collection
- Specified by:
remove
in interfacejava.util.Set
- Overrides:
remove
in classjava.util.AbstractCollection
- 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 interfacejava.util.Collection
- Specified by:
clear
in interfacejava.util.Set
- Overrides:
clear
in classjava.util.AbstractCollection
-
clone
public java.lang.Object clone()
Returns a shallow copy of this ListSet instance.- Overrides:
clone
in classjava.lang.Object
- Returns:
- A shallow copy of this set.
-
-