java.util
Class EnumSet<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
      extended by java.util.AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet <E>
          extended by java.util.EnumSet<E>
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Iterable sample code for java.lang.Iterable definition code for java.lang.Iterable <E>, Collection sample code for java.util.Collection definition code for java.util.Collection <E>, Set sample code for java.util.Set definition code for java.util.Set <E>

public abstract class EnumSet<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
extends AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet <E>
implements Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

A specialized Set sample code for java.util.Set definition code for java.util.Set implementation for use with enum types. All of the elements in an enum set must come from a single enum type that is specified, explicitly or implicitly, when the set is created. Enum sets are represented internally as bit vectors. This representation is extremely compact and efficient. The space and time performance of this class should be good enough to allow its use as a high-quality, typesafe alternative to traditional int-based "bit flags." Even bulk operations (such as containsAll and retainAll) should run very quickly if the specified collection is also an enum set.

The iterator returned by the iteratormethod traverses the elements in their natural order (the order in which the enum constants are declared). The returned iterator is weakly consistent: it will never throw ConcurrentModificationException sample code for java.util.ConcurrentModificationException definition code for java.util.ConcurrentModificationException and it may or may not show the effects of any modifications to the set that occur while the iteration is in progress.

Null elements are not permitted. Attempts to insert a null element will throw NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException . Attempts to test for the presence of a null element or to remove one will, however, function properly.

Like most collection implementations EnumSet is not synchronized. If multiple threads access an enum set concurrently, and at least one of the threads modifies the set, it should be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the enum set. If no such object exists, the set should be "wrapped" using the Collections.synchronizedSet(java.util.Set) sample code for java.util.Collections.synchronizedSet(java.util.Set) definition code for java.util.Collections.synchronizedSet(java.util.Set) method. This is best done at creation time, to prevent accidental unsynchronized access:

 Set<MyEnum> s = Collections.synchronizedSet(EnumSet.noneOf(Foo.class));
 

Implementation note: All basic operations execute in constant time. They are likely (though not guaranteed) to be much faster than their HashSet sample code for java.util.HashSet definition code for java.util.HashSet counterparts. Even bulk operations, such as addAll() sample code for java.util.EnumSet.addAll() definition code for java.util.EnumSet.addAll() and AbstractSet.removeAll(java.util.Collection) sample code for java.util.AbstractSet.removeAll(java.util.Collection) definition code for java.util.AbstractSet.removeAll(java.util.Collection) execute in constant time if the parameter is another EnumSet instance.

This class is a member of the Java Collections Framework.

Since:
1.5
See Also:
EnumMap sample code for java.util.EnumMap definition code for java.util.EnumMap

Method Summary
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
allOf sample code for java.util.EnumSet.allOf(java.lang.Class) definition code for java.util.EnumSet.allOf(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <E> elementType)
          Creates an enum set containing all of the elements in the specified element type.
 EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> clone sample code for java.util.EnumSet.clone() definition code for java.util.EnumSet.clone() ()
          Returns a copy of this set.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
complementOf sample code for java.util.EnumSet.complementOf(java.util.EnumSet) definition code for java.util.EnumSet.complementOf(java.util.EnumSet) (EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> s)
          Creates an enum set with the same element type as the specified enum set, initially containing all the elements of this type that are not contained in the specified set.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
copyOf sample code for java.util.EnumSet.copyOf(java.util.Collection) definition code for java.util.EnumSet.copyOf(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <E> c)
          Creates an enum set initialized from the specified collection.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
copyOf sample code for java.util.EnumSet.copyOf(java.util.EnumSet) definition code for java.util.EnumSet.copyOf(java.util.EnumSet) (EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> s)
          Creates an enum set with the same element type as the specified enum set, initially containing the same elements (if any).
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
noneOf sample code for java.util.EnumSet.noneOf(java.lang.Class) definition code for java.util.EnumSet.noneOf(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <E> elementType)
          Creates an empty enum set with the specified element type.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
of sample code for java.util.EnumSet.of(E) definition code for java.util.EnumSet.of(E) (E e)
          Creates an enum set initially containing the specified element.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
of sample code for java.util.EnumSet.of(E, E...) definition code for java.util.EnumSet.of(E, E...) (E first, E... rest)
          Creates an enum set initially containing the specified elements.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
of sample code for java.util.EnumSet.of(E, E) definition code for java.util.EnumSet.of(E, E) (E e1, E e2)
          Creates an enum set initially containing the specified elements.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
of sample code for java.util.EnumSet.of(E, E, E) definition code for java.util.EnumSet.of(E, E, E) (E e1, E e2, E e3)
          Creates an enum set initially containing the specified elements.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
of sample code for java.util.EnumSet.of(E, E, E, E) definition code for java.util.EnumSet.of(E, E, E, E) (E e1, E e2, E e3, E e4)
          Creates an enum set initially containing the specified elements.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
of sample code for java.util.EnumSet.of(E, E, E, E, E) definition code for java.util.EnumSet.of(E, E, E, E, E) (E e1, E e2, E e3, E e4, E e5)
          Creates an enum set initially containing the specified elements.
static
<E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>>
EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E>
range sample code for java.util.EnumSet.range(E, E) definition code for java.util.EnumSet.range(E, E) (E from, E to)
          Creates an enum set initially containing all of the elements in the range defined by the two specified endpoints.
 
Methods inherited from class java.util.AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet
equals sample code for java.util.AbstractSet.equals(java.lang.Object) definition code for java.util.AbstractSet.equals(java.lang.Object) , hashCode sample code for java.util.AbstractSet.hashCode() definition code for java.util.AbstractSet.hashCode() , removeAll sample code for java.util.AbstractSet.removeAll(java.util.Collection) definition code for java.util.AbstractSet.removeAll(java.util.Collection)
 
Methods inherited from class java.util.AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection
add sample code for java.util.AbstractCollection.add(E) definition code for java.util.AbstractCollection.add(E) , addAll sample code for java.util.AbstractCollection.addAll(java.util.Collection) definition code for java.util.AbstractCollection.addAll(java.util.Collection) , clear sample code for java.util.AbstractCollection.clear() definition code for java.util.AbstractCollection.clear() , contains sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object) , containsAll sample code for java.util.AbstractCollection.containsAll(java.util.Collection) definition code for java.util.AbstractCollection.containsAll(java.util.Collection) , isEmpty sample code for java.util.AbstractCollection.isEmpty() definition code for java.util.AbstractCollection.isEmpty() , iterator sample code for java.util.AbstractCollection.iterator() definition code for java.util.AbstractCollection.iterator() , remove sample code for java.util.AbstractCollection.remove(java.lang.Object) definition code for java.util.AbstractCollection.remove(java.lang.Object) , retainAll sample code for java.util.AbstractCollection.retainAll(java.util.Collection) definition code for java.util.AbstractCollection.retainAll(java.util.Collection) , size sample code for java.util.AbstractCollection.size() definition code for java.util.AbstractCollection.size() , toArray sample code for java.util.AbstractCollection.toArray() definition code for java.util.AbstractCollection.toArray() , toArray sample code for java.util.AbstractCollection.toArray(T[]) definition code for java.util.AbstractCollection.toArray(T[]) , toString sample code for java.util.AbstractCollection.toString() definition code for java.util.AbstractCollection.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 
Methods inherited from interface java.util.Set sample code for java.util.Set definition code for java.util.Set
add sample code for java.util.Set.add(E) definition code for java.util.Set.add(E) , addAll sample code for java.util.Set.addAll(java.util.Collection) definition code for java.util.Set.addAll(java.util.Collection) , clear sample code for java.util.Set.clear() definition code for java.util.Set.clear() , contains sample code for java.util.Set.contains(java.lang.Object) definition code for java.util.Set.contains(java.lang.Object) , containsAll sample code for java.util.Set.containsAll(java.util.Collection) definition code for java.util.Set.containsAll(java.util.Collection) , isEmpty sample code for java.util.Set.isEmpty() definition code for java.util.Set.isEmpty() , iterator sample code for java.util.Set.iterator() definition code for java.util.Set.iterator() , remove sample code for java.util.Set.remove(java.lang.Object) definition code for java.util.Set.remove(java.lang.Object) , retainAll sample code for java.util.Set.retainAll(java.util.Collection) definition code for java.util.Set.retainAll(java.util.Collection) , size sample code for java.util.Set.size() definition code for java.util.Set.size() , toArray sample code for java.util.Set.toArray() definition code for java.util.Set.toArray() , toArray sample code for java.util.Set.toArray(T[]) definition code for java.util.Set.toArray(T[])
 

Method Detail

noneOf sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>noneOf(java.lang.Class<E>) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>noneOf(java.lang.Class<E>)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> noneOf(Class sample code for java.lang.Class definition code for java.lang.Class <E> elementType)
Creates an empty enum set with the specified element type.

Parameters:
elementType - the class object of the element type for this enum set
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if elementType is null

allOf sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>allOf(java.lang.Class<E>) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>allOf(java.lang.Class<E>)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> allOf(Class sample code for java.lang.Class definition code for java.lang.Class <E> elementType)
Creates an enum set containing all of the elements in the specified element type.

Parameters:
elementType - the class object of the element type for this enum set
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if elementType is null

copyOf sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>copyOf(java.util.EnumSet<E>) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>copyOf(java.util.EnumSet<E>)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> copyOf(EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> s)
Creates an enum set with the same element type as the specified enum set, initially containing the same elements (if any).

Parameters:
s - the enum set from which to initialize this enum set
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if s is null

copyOf sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>copyOf(java.util.Collection<E>) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>copyOf(java.util.Collection<E>)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> copyOf(Collection sample code for java.util.Collection definition code for java.util.Collection <E> c)
Creates an enum set initialized from the specified collection. If the specified collection is an EnumSet instance, this static factory method behaves identically to copyOf(EnumSet) sample code for java.util.EnumSet.copyOf(java.util.EnumSet) definition code for java.util.EnumSet.copyOf(java.util.EnumSet) . Otherwise, the specified collection must contain at least one element (in order to determine the new enum set's element type).

Parameters:
c - the collection from which to initialize this enum set
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if c is not an EnumSet instance and contains no elements
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if c is null

complementOf sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>complementOf(java.util.EnumSet<E>) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>complementOf(java.util.EnumSet<E>)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> complementOf(EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> s)
Creates an enum set with the same element type as the specified enum set, initially containing all the elements of this type that are not contained in the specified set.

Parameters:
s - the enum set from whose complement to initialize this enum set
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if s is null

of sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> of(E e)
Creates an enum set initially containing the specified element. Overloadings of this method exist to initialize an enum set with one through five elements. A sixth overloading is provided that uses the varargs feature. This overloading may be used to create an an enum set initially containing an arbitrary number of elements, but is likely to run slower than the overloadings that do not use varargs.

Parameters:
e - the element that this set is to contain initially
Returns:
an enum set initially containing the specified element
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if e is null

of sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> of(E e1,
                                                E e2)
Creates an enum set initially containing the specified elements. Overloadings of this method exist to initialize an enum set with one through five elements. A sixth overloading is provided that uses the varargs feature. This overloading may be used to create an an enum set initially containing an arbitrary number of elements, but is likely to run slower than the overloadings that do not use varargs.

Parameters:
e1 - an element that this set is to contain initially
e2 - another element that this set is to contain initially
Returns:
an enum set initially containing the specified elements
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if any parameters are null

of sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E, E) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E, E)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> of(E e1,
                                                E e2,
                                                E e3)
Creates an enum set initially containing the specified elements. Overloadings of this method exist to initialize an enum set with one through five elements. A sixth overloading is provided that uses the varargs feature. This overloading may be used to create an an enum set initially containing an arbitrary number of elements, but is likely to run slower than the overloadings that do not use varargs.

Parameters:
e1 - an element that this set is to contain initially
e2 - another element that this set is to contain initially
e3 - another element that this set is to contain initially
Returns:
an enum set initially containing the specified elements
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if any parameters are null

of sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E, E, E) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E, E, E)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> of(E e1,
                                                E e2,
                                                E e3,
                                                E e4)
Creates an enum set initially containing the specified elements. Overloadings of this method exist to initialize an enum set with one through five elements. A sixth overloading is provided that uses the varargs feature. This overloading may be used to create an an enum set initially containing an arbitrary number of elements, but is likely to run slower than the overloadings that do not use varargs.

Parameters:
e1 - an element that this set is to contain initially
e2 - another element that this set is to contain initially
e3 - another element that this set is to contain initially
e4 - another element that this set is to contain initially
Returns:
an enum set initially containing the specified elements
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if any parameters are null

of sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E, E, E, E) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E, E, E, E)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> of(E e1,
                                                E e2,
                                                E e3,
                                                E e4,
                                                E e5)
Creates an enum set initially containing the specified elements. Overloadings of this method exist to initialize an enum set with one through five elements. A sixth overloading is provided that uses the varargs feature. This overloading may be used to create an an enum set initially containing an arbitrary number of elements, but is likely to run slower than the overloadings that do not use varargs.

Parameters:
e1 - an element that this set is to contain initially
e2 - another element that this set is to contain initially
e3 - another element that this set is to contain initially
e4 - another element that this set is to contain initially
e5 - another element that this set is to contain initially
Returns:
an enum set initially containing the specified elements
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if any parameters are null

of sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E...) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>of(E, E...)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> of(E first,
                                                E... rest)
Creates an enum set initially containing the specified elements. This factory, whose parameter list uses the varargs feature, may be used to create an enum set initially containing an arbitrary number of elements, but it is likely to run slower than the overloadings that do not use varargs.

Parameters:
first - an element that the set is to contain initially
rest - the remaining elements the set is to contain initially
Returns:
an enum set initially containing the specified elements
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if any of the specified elements are null, or if rest is null

range sample code for java.util.EnumSet.<E extends java.lang.Enum<E>>range(E, E) definition code for java.util.EnumSet.<E extends java.lang.Enum<E>>range(E, E)

public static <E extends Enum sample code for java.lang.Enum definition code for java.lang.Enum <E>> EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> range(E from,
                                                   E to)
Creates an enum set initially containing all of the elements in the range defined by the two specified endpoints. The returned set will contain the endpoints themselves, which may be identical but must not be out of order.

Parameters:
from - the first element in the range
to - the last element in the range
Returns:
an enum set initially containing all of the elements in the range defined by the two specified endpoints
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if first or last are null
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if first.compareTo(last) > 0

clone sample code for java.util.EnumSet.clone() definition code for java.util.EnumSet.clone()

public EnumSet sample code for java.util.EnumSet definition code for java.util.EnumSet <E> clone()
Returns a copy of this set.

Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a copy of this set.
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable