java/util/EnumSet.java

8  * particular file as subject to the "Classpath" exception as provided
18  * 2 along with this work; if not, write to the Free Software Foundation,
36  * class should be good enough to allow its use as a high-quality, typesafe
37  * alternative to traditional {@code int}-based "bit flags."  Even bulk
45  * and it may or may not show the effects of any modifications to the set that
48  * <p>Null elements are not permitted.  Attempts to insert a null element
49  * will throw {@link NullPointerException}.  Attempts to test for the
50  * presence of a null element or to remove one will, however, function
59  * method.  This is best done at creation time, to prevent accidental
67  * They are likely (though not guaranteed) to be much faster than their
80 @SuppressWarnings("serial") // No serialVersionUID due to usage of
137      * Adds all of the elements from the appropriate enum type to this enum
138      * set, which is empty prior to the call.
147      * @param s the enum set from which to initialize this enum set
158      * factory method behaves identically to {@link #copyOf(EnumSet)}.
160      * (in order to determine the new enum set's element type).
163      * @param c the collection from which to initialize this enum set
190      * @param s the enum set from whose complement to initialize this enum set
203      * Overloadings of this method exist to initialize an enum set with
205      * uses the varargs feature.  This overloading may be used to create
207      * is likely to run slower than the overloadings that do not use varargs.
210      * @param e the element that this set is to contain initially
223      * Overloadings of this method exist to initialize an enum set with
225      * uses the varargs feature.  This overloading may be used to create
227      * is likely to run slower than the overloadings that do not use varargs.
230      * @param e1 an element that this set is to contain initially
231      * @param e2 another element that this set is to contain initially
245      * Overloadings of this method exist to initialize an enum set with
247      * uses the varargs feature.  This overloading may be used to create
249      * is likely to run slower than the overloadings that do not use varargs.
252      * @param e1 an element that this set is to contain initially
253      * @param e2 another element that this set is to contain initially
254      * @param e3 another element that this set is to contain initially
269      * Overloadings of this method exist to initialize an enum set with
271      * uses the varargs feature.  This overloading may be used to create
273      * is likely to run slower than the overloadings that do not use varargs.
276      * @param e1 an element that this set is to contain initially
277      * @param e2 another element that this set is to contain initially
278      * @param e3 another element that this set is to contain initially
279      * @param e4 another element that this set is to contain initially
295      * Overloadings of this method exist to initialize an enum set with
297      * uses the varargs feature.  This overloading may be used to create
299      * is likely to run slower than the overloadings that do not use varargs.
302      * @param e1 an element that this set is to contain initially
303      * @param e2 another element that this set is to contain initially
304      * @param e3 another element that this set is to contain initially
305      * @param e4 another element that this set is to contain initially
306      * @param e5 another element that this set is to contain initially
325      * be used to create an enum set initially containing an arbitrary
326      * number of elements, but it is likely to run slower than the overloadings
330      * @param first an element that the set is to contain initially
331      * @param rest the remaining elements the set is to contain initially
353      * @param to the last element in the range
354      * @throws NullPointerException if {@code from} or {@code to} are null
355      * @throws IllegalArgumentException if {@code from.compareTo(to) > 0}
359     public static <E extends Enum<E>> EnumSet<E> range(E from, E to) {
360         if (from.compareTo(to) > 0)
361             throw new IllegalArgumentException(from + " > " + to);
363         result.addRange(from, to);
368      * Adds the specified range to this enum set, which is empty prior
369      * to the call.
371     abstract void addRange(E from, E to);
411      * This class is used to serialize all EnumSet instances, regardless of
414      * to ensure that the existence of a particular implementation type is
444         // instead of cast to E, we should perhaps use elementType.cast()
445         // to avoid injection of forged stream, but it will slow the implementation