| java.util.EnumSet
| EnumSet | | abstract public class EnumSet extends AbstractSet implements Cloneable,java.io.Serializable(Code) | | A specialized
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 their argument is also an enum set.
The iterator returned by the iterator method 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 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 . 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 method. This is best done at creation time, to prevent accidental
unsynchronized access:
Set<MyEnum> s = Collections.synchronizedSet(EnumSet.noneOf(MyEnum.class));
Implementation note: All basic operations execute in constant time.
They are likely (though not guaranteed) to be much faster than their
HashSet counterparts. Even bulk operations execute in
constant time if their argument is also an enum set.
This class is a member of the
Java Collections Framework.
author:
Josh Bloch
version:
1.21, 05/05/07
since:
1.5
See Also: EnumMap |
| Method Summary | |
| abstract void | addAll()
Adds all of the elements from the appropriate enum type to this enum
set, which is empty prior to the call. | | abstract void | addRange(E from, E to)
Adds the specified range to this enum set, which is empty prior
to the call. | | public static EnumSet<E> | allOf(Class<E> elementType)
Creates an enum set containing all of the elements in the specified
element type. | | public EnumSet<E> | clone()
Returns a copy of this set. | | abstract void | complement()
Complements the contents of this enum set. | | public static EnumSet<E> | complementOf(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. | | public static EnumSet<E> | copyOf(EnumSet<E> s)
Creates an enum set with the same element type as the specified enum
set, initially containing the same elements (if any). | | public static EnumSet<E> | copyOf(Collection<E> c)
Creates an enum set initialized from the specified collection. | | public static EnumSet<E> | noneOf(Class<E> elementType)
Creates an empty enum set with the specified element type. | | public static 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. | | public static 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. | | public static 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. | | public static 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. | | public static 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. | | public static EnumSet<E> | of(E first, E... rest)
Creates an enum set initially containing the specified elements. | | public static 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. | | final void | typeCheck(E e)
Throws an exception if e is not of the correct type for this enum set. | | Object | writeReplace()
|
| elementType | | final Class<E> elementType(Code) | | The class of all the elements of this set.
|
| universe | | final Enum[] universe(Code) | | All of the values comprising T. (Cached for performance.)
|
| addAll | | abstract void addAll()(Code) | | Adds all of the elements from the appropriate enum type to this enum
set, which is empty prior to the call.
|
| addRange | | abstract void addRange(E from, E to)(Code) | | Adds the specified range to this enum set, which is empty prior
to the call.
|
| allOf | | public static EnumSet<E> allOf(Class<E> elementType)(Code) | | 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 enumset
throws:
NullPointerException - if elementType is null |
| clone | | public EnumSet<E> clone()(Code) | | Returns a copy of this set.
a copy of this set |
| complement | | abstract void complement()(Code) | | Complements the contents of this enum set.
|
| complementOf | | public static EnumSet<E> complementOf(EnumSet<E> s)(Code) | | 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 - if s is null |
| copyOf | | public static EnumSet<E> copyOf(EnumSet<E> s)(Code) | | 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 - if s is null |
| copyOf | | public static EnumSet<E> copyOf(Collection<E> c)(Code) | | Creates an enum set initialized from the specified collection. If
the specified collection is an EnumSet instance, this static
factory method behaves identically to
EnumSet.copyOf(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 - if c is not anEnumSet instance and contains no elements
throws:
NullPointerException - if c is null |
| noneOf | | public static EnumSet<E> noneOf(Class<E> elementType)(Code) | | Creates an empty enum set with the specified element type.
Parameters:
elementType - the class object of the element type for this enumset
throws:
NullPointerException - if elementType is null |
| of | | public static EnumSet<E> of(E e)(Code) | | 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 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
throws:
NullPointerException - if e is null an enum set initially containing the specified element |
| of | | public static EnumSet<E> of(E e1, E e2)(Code) | | 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 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
Parameters:
e2 - another element that this set is to contain initially
throws:
NullPointerException - if any parameters are null an enum set initially containing the specified elements |
| of | | public static EnumSet<E> of(E e1, E e2, E e3)(Code) | | 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 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
Parameters:
e2 - another element that this set is to contain initially
Parameters:
e3 - another element that this set is to contain initially
throws:
NullPointerException - if any parameters are null an enum set initially containing the specified elements |
| of | | public static EnumSet<E> of(E e1, E e2, E e3, E e4)(Code) | | 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 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
Parameters:
e2 - another element that this set is to contain initially
Parameters:
e3 - another element that this set is to contain initially
Parameters:
e4 - another element that this set is to contain initially
throws:
NullPointerException - if any parameters are null an enum set initially containing the specified elements |
| of | | public static EnumSet<E> of(E e1, E e2, E e3, E e4, E e5)(Code) | | 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 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
Parameters:
e2 - another element that this set is to contain initially
Parameters:
e3 - another element that this set is to contain initially
Parameters:
e4 - another element that this set is to contain initially
Parameters:
e5 - another element that this set is to contain initially
throws:
NullPointerException - if any parameters are null an enum set initially containing the specified elements |
| of | | public static EnumSet<E> of(E first, E... rest)(Code) | | 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
Parameters:
rest - the remaining elements the set is to contain initially
throws:
NullPointerException - if any of the specified elements are null,or if rest is null an enum set initially containing the specified elements |
| range | | public static EnumSet<E> range(E from, E to)(Code) | | 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
Parameters:
to - the last element in the range
throws:
NullPointerException - if first or last arenull
throws:
IllegalArgumentException - if first.compareTo(last) > 0 an enum set initially containing all of the elements in therange defined by the two specified endpoints |
| typeCheck | | final void typeCheck(E e)(Code) | | Throws an exception if e is not of the correct type for this enum set.
|
|
|