EnumSet
abstract class EnumSet<E : Enum<E>!> : AbstractSet<E>, Cloneable, Serializable
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.
Summary
| Public methods |
| open static EnumSet<E>! |
Creates an enum set containing all of the elements in the specified element type.
|
| open EnumSet<E> |
Returns a copy of this set.
|
| open static EnumSet<E>! |
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.
|
| open static EnumSet<E>! |
Creates an enum set with the same element type as the specified enum set, initially containing the same elements (if any).
|
| open static EnumSet<E>! |
Creates an enum set initialized from the specified collection.
|
| open static EnumSet<E>! |
Creates an empty enum set with the specified element type.
|
| open static EnumSet<E>! |
Creates an enum set initially containing the specified element.
|
| open static EnumSet<E>! |
Creates an enum set initially containing the specified elements.
|
| open static EnumSet<E>! |
Creates an enum set initially containing the specified elements.
|
| open static EnumSet<E>! |
of(e1: E, e2: E, e3: E, e4: E)Creates an enum set initially containing the specified elements.
|
| open static EnumSet<E>! |
of(e1: E, e2: E, e3: E, e4: E, e5: E)Creates an enum set initially containing the specified elements.
|
| open static EnumSet<E>! |
of(first: E, vararg rest: E)Creates an enum set initially containing the specified elements.
|
| open static EnumSet<E>! |
Creates an enum set initially containing all of the elements in the range defined by the two specified endpoints.
|
| Inherited functions |
From class AbstractCollection
Boolean |
add(element: E)
Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)
Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.
If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.
|
Boolean |
addAll(elements: Collection<E>)
Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)
|
Unit |
clear()
Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.
|
Boolean |
contains(element: E?)
Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e).
|
Boolean |
containsAll(elements: Collection<E>)
Returns true if this collection contains all of the elements in the specified collection.
|
Boolean |
isEmpty()
Returns true if this collection contains no elements.
|
MutableIterator<E> |
iterator()
Returns an iterator over the elements contained in this collection.
|
Boolean |
remove(element: E?)
Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
|
Boolean |
retainAll(elements: Collection<E>)
Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.
|
Array<Any!> |
toArray()
Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is Object.
The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
|
Array<T> |
toArray(a: Array<T>)
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.
If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)
If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
|
String |
toString()
Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf(Object).
|
|
From class AbstractSet
Boolean |
equals(other: Any?)
Compares the specified object with this set for equality. Returns true if the given object is also a set, the two sets have the same size, and every member of the given set is contained in this set. This ensures that the equals method works properly across different implementations of the Set interface.
This implementation first checks if the specified object is this set; if so it returns true. Then, it checks if the specified object is a set whose size is identical to the size of this set; if not, it returns false. If so, it returns containsAll((Collection) o).
|
Int |
hashCode()
Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object#hashCode.
This implementation iterates over the set, calling the hashCode method on each element in the set, and adding up the results.
|
Boolean |
removeAll(elements: Collection<E>)
Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.
This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.
Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.
|
|
Public methods
allOf
open static fun <E : Enum<E>!> allOf(elementType: Class<E>!): EnumSet<E>!
Creates an enum set containing all of the elements in the specified element type.
| Parameters |
<E> |
The class of the elements in the set |
elementType |
Class<E>!: the class object of the element type for this enum set |
| Return |
EnumSet<E>! |
An enum set containing all the elements in the specified type. |
| Exceptions |
java.lang.NullPointerException |
if elementType is null |
clone
open fun clone(): EnumSet<E>
Returns a copy of this set.
| Return |
EnumSet<E> |
a copy of this set |
| Exceptions |
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
complementOf
open static fun <E : Enum<E>!> complementOf(s: EnumSet<E>!): EnumSet<E>!
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 |
<E> |
The class of the elements in the enum set |
s |
EnumSet<E>!: the enum set from whose complement to initialize this enum set |
| Return |
EnumSet<E>! |
The complement of the specified set in this set |
| Exceptions |
java.lang.NullPointerException |
if s is null |
copyOf
open static fun <E : Enum<E>!> copyOf(s: EnumSet<E>!): EnumSet<E>!
Creates an enum set with the same element type as the specified enum set, initially containing the same elements (if any).
| Parameters |
<E> |
The class of the elements in the set |
s |
EnumSet<E>!: the enum set from which to initialize this enum set |
| Return |
EnumSet<E>! |
A copy of the specified enum set. |
| Exceptions |
java.lang.NullPointerException |
if s is null |
copyOf
open static fun <E : Enum<E>!> copyOf(c: MutableCollection<E>!): EnumSet<E>!
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(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 |
<E> |
The class of the elements in the collection |
c |
MutableCollection<E>!: the collection from which to initialize this enum set |
| Return |
EnumSet<E>! |
An enum set initialized from the given collection. |
| Exceptions |
java.lang.IllegalArgumentException |
if c is not an EnumSet instance and contains no elements |
java.lang.NullPointerException |
if c is null |
noneOf
open static fun <E : Enum<E>!> noneOf(elementType: Class<E>!): EnumSet<E>!
Creates an empty enum set with the specified element type.
| Parameters |
<E> |
The class of the elements in the set |
elementType |
Class<E>!: the class object of the element type for this enum set |
| Return |
EnumSet<E>! |
An empty enum set of the specified type. |
| Exceptions |
java.lang.NullPointerException |
if elementType is null |
of
open static fun <E : Enum<E>!> of(e: E): EnumSet<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 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 class of the specified element and of the set |
e |
E: the element that this set is to contain initially |
| Return |
EnumSet<E>! |
an enum set initially containing the specified element |
| Exceptions |
java.lang.NullPointerException |
if e is null |
of
open static fun <E : Enum<E>!> of(
e1: E,
e2: E
): EnumSet<E>!
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 |
<E> |
The class of the parameter elements and of the set |
e1 |
E: an element that this set is to contain initially |
e2 |
E: another element that this set is to contain initially |
| Return |
EnumSet<E>! |
an enum set initially containing the specified elements |
| Exceptions |
java.lang.NullPointerException |
if any parameters are null |
of
open static fun <E : Enum<E>!> of(
e1: E,
e2: E,
e3: E
): EnumSet<E>!
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 |
<E> |
The class of the parameter elements and of the set |
e1 |
E: an element that this set is to contain initially |
e2 |
E: another element that this set is to contain initially |
e3 |
E: another element that this set is to contain initially |
| Return |
EnumSet<E>! |
an enum set initially containing the specified elements |
| Exceptions |
java.lang.NullPointerException |
if any parameters are null |
of
open static fun <E : Enum<E>!> of(
e1: E,
e2: E,
e3: E,
e4: E
): EnumSet<E>!
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 |
<E> |
The class of the parameter elements and of the set |
e1 |
E: an element that this set is to contain initially |
e2 |
E: another element that this set is to contain initially |
e3 |
E: another element that this set is to contain initially |
e4 |
E: another element that this set is to contain initially |
| Return |
EnumSet<E>! |
an enum set initially containing the specified elements |
| Exceptions |
java.lang.NullPointerException |
if any parameters are null |
of
open static fun <E : Enum<E>!> of(
e1: E,
e2: E,
e3: E,
e4: E,
e5: E
): EnumSet<E>!
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 |
<E> |
The class of the parameter elements and of the set |
e1 |
E: an element that this set is to contain initially |
e2 |
E: another element that this set is to contain initially |
e3 |
E: another element that this set is to contain initially |
e4 |
E: another element that this set is to contain initially |
e5 |
E: another element that this set is to contain initially |
| Return |
EnumSet<E>! |
an enum set initially containing the specified elements |
| Exceptions |
java.lang.NullPointerException |
if any parameters are null |
of
@SafeVarargs open static fun <E : Enum<E>!> of(
first: E,
vararg rest: E
): EnumSet<E>!
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 |
<E> |
The class of the parameter elements and of the set |
first |
E: an element that the set is to contain initially |
rest |
E: the remaining elements the set is to contain initially |
| Return |
EnumSet<E>! |
an enum set initially containing the specified elements |
| Exceptions |
java.lang.NullPointerException |
if any of the specified elements are null, or if rest is null |
range
open static fun <E : Enum<E>!> range(
from: E,
to: E
): EnumSet<E>!
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 |
<E> |
The class of the parameter elements and of the set |
from |
E: the first element in the range |
to |
E: the last element in the range |
| Return |
EnumSet<E>! |
an enum set initially containing all of the elements in the range defined by the two specified endpoints |
| Exceptions |
java.lang.NullPointerException |
if from or to are null |
java.lang.IllegalArgumentException |
if from.compareTo(to) > 0 |
