declare namespace java {
namespace util {
/**
* A specialized {@link 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 {@link 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 {@link 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 {@link 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
* {@link 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
* @since 1.5
* @see EnumMap
* @serial exclude
*/
// @ts-ignore
abstract class EnumSet> extends java.util.AbstractSet implements java.lang.Cloneable, java.io.Serializable {
/**
* Creates an empty enum set with the specified element type.
* @param The class of the elements in the set
* @param elementType the class object of the element type for this enum
* set
* @return An empty enum set of the specified type.
* @throws NullPointerException if elementType is null
*/
// @ts-ignore
public static noneOf>(elementType: java.lang.Class): java.util.EnumSet
/**
* Creates an enum set containing all of the elements in the specified
* element type.
* @param The class of the elements in the set
* @param elementType the class object of the element type for this enum
* set
* @return An enum set containing all the elements in the specified type.
* @throws NullPointerException if elementType is null
*/
// @ts-ignore
public static allOf>(elementType: java.lang.Class): java.util.EnumSet
/**
* Creates an enum set with the same element type as the specified enum
* set, initially containing the same elements (if any).
* @param The class of the elements in the set
* @param s the enum set from which to initialize this enum set
* @return A copy of the specified enum set.
* @throws NullPointerException if s is null
*/
// @ts-ignore
public static copyOf>(s: java.util.EnumSet): java.util.EnumSet
/**
* Creates an enum set initialized from the specified collection. If
* the specified collection is an EnumSet instance, this static
* factory method behaves identically to {@link #copyOf(EnumSet)}.
* Otherwise, the specified collection must contain at least one element
* (in order to determine the new enum set's element type).
* @param The class of the elements in the collection
* @param c the collection from which to initialize this enum set
* @return An enum set initialized from the given collection.
* @throws IllegalArgumentException if c is not an
* EnumSet instance and contains no elements
* @throws NullPointerException if c is null
*/
// @ts-ignore
public static copyOf>(c: java.util.Collection | Array): java.util.EnumSet
/**
* 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.
* @param The class of the elements in the enum set
* @param s the enum set from whose complement to initialize this enum set
* @return The complement of the specified set in this set
* @throws NullPointerException if s is null
*/
// @ts-ignore
public static complementOf>(s: java.util.EnumSet): java.util.EnumSet
/**
* 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.
* @param The class of the specified element and of the set
* @param e the element that this set is to contain initially
* @throws NullPointerException if e is null
* @return an enum set initially containing the specified element
*/
// @ts-ignore
public static of>(e: E): java.util.EnumSet
/**
* 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.
* @param The class of the parameter elements and of the set
* @param e1 an element that this set is to contain initially
* @param e2 another element that this set is to contain initially
* @throws NullPointerException if any parameters are null
* @return an enum set initially containing the specified elements
*/
// @ts-ignore
public static of>(e1: E, e2: E): java.util.EnumSet
/**
* 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.
* @param The class of the parameter elements and of the set
* @param e1 an element that this set is to contain initially
* @param e2 another element that this set is to contain initially
* @param e3 another element that this set is to contain initially
* @throws NullPointerException if any parameters are null
* @return an enum set initially containing the specified elements
*/
// @ts-ignore
public static of>(e1: E, e2: E, e3: E): java.util.EnumSet
/**
* 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.
* @param The class of the parameter elements and of the set
* @param e1 an element that this set is to contain initially
* @param e2 another element that this set is to contain initially
* @param e3 another element that this set is to contain initially
* @param e4 another element that this set is to contain initially
* @throws NullPointerException if any parameters are null
* @return an enum set initially containing the specified elements
*/
// @ts-ignore
public static of>(e1: E, e2: E, e3: E, e4: E): java.util.EnumSet
/**
* 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.
* @param The class of the parameter elements and of the set
* @param e1 an element that this set is to contain initially
* @param e2 another element that this set is to contain initially
* @param e3 another element that this set is to contain initially
* @param e4 another element that this set is to contain initially
* @param e5 another element that this set is to contain initially
* @throws NullPointerException if any parameters are null
* @return an enum set initially containing the specified elements
*/
// @ts-ignore
public static of>(e1: E, e2: E, e3: E, e4: E, e5: E): java.util.EnumSet
/**
* 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.
* @param The class of the parameter elements and of the set
* @param first an element that the set is to contain initially
* @param 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
* @return an enum set initially containing the specified elements
*/
// @ts-ignore
public static of>(first: E, ...rest: E[]): java.util.EnumSet
/**
* 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.
* @param The class of the parameter elements and of the set
* @param from the first element in the range
* @param to the last element in the range
* @throws NullPointerException if {#code from} or {@code to} are null
* @throws IllegalArgumentException if {#code from.compareTo(to) > 0}
* @return an enum set initially containing all of the elements in the
* range defined by the two specified endpoints
*/
// @ts-ignore
public static range>(from: E, to: E): java.util.EnumSet
/**
* Returns a copy of this set.
* @return a copy of this set
*/
// @ts-ignore
public clone(): java.util.EnumSet
}
}
}