Класс EnumSet<E extends Enum<E>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.EnumSet<E>

Все реализованные интерфейсы:: Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>

public abstract class EnumSet<E extends Enum<E>> extends AbstractSet<E> implements Cloneable, Serializable

Специализированная реализация интерфейса Set для использования с типами перечислений. Все элементы в наборе перечислений должны принадлежать одному типу перечисления, который задаётся явно или неявно при создании набора. Наборы перечислений представляются внутри как битовые векторы. Это представление чрезвычайно компактное и эффективное. Производительность этого класса по времени и памяти должна быть достаточной, чтобы использовать его в качестве высококачественной, безопасной по типам альтернативы традиционным int-основанным "флагам". Даже операции с блоками (например, containsAll и retainAll) должны выполняться очень быстро, если их аргументом также является набор перечислений.

Итератор, возвращаемый методом iterator, просматривает элементы в их естественном порядке (порядке объявления констант перечисления). Возвращаемый итератор слабо согласован: он никогда не выбросит ConcurrentModificationException, и он может или не может показать результаты любых изменений в наборе, которые происходят во время итерации.

Элементы типа null не допускаются. Попытки вставки элемента null вызовут NullPointerException. Однако попытки проверить наличие элемента null или удалить его будут работать правильно.

Как и большинство реализаций коллекций, EnumSet не является синхронизированным. Если к набору перечислений одновременный доступ нескольких потоков, и хотя бы один из потоков изменяет набор, он должен быть синхронизирован внешне. Обычно это достигается синхронизацией на каком-либо объекте, естественным образом инкапсулирующем набор перечислений. Если такого объекта нет, набор должен быть "обернут" с помощью метода Collections.synchronizedSet(java.util.Set<T>). Это лучше всего сделать при создании, чтобы предотвратить случайный несинхронизированный доступ:

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

Примечание реализации: все базовые операции выполняются за постоянное время. Вероятнее всего (хотя и не гарантируется), что они будут намного быстрее, чем их аналоги из класса HashSet. Даже операции с блоками выполняются за постоянное время, если их аргументом также является набор перечислений.

Этот класс является членом Java Collections Framework.

Since:

1.5

См. также:

Краткое описание методов

Модификатор и тип	Метод	Описание
`static <E extends Enum<E>> EnumSet<E>`	`allOf(Class<E> elementType)`	Создаёт набор перечислений, содержащий все элементы указанного типа перечисления.
`EnumSet<E>`	`clone()`	Возвращает копию этого набора.
`static <E extends Enum<E>> EnumSet<E>`	`complementOf(EnumSet<E> s)`	Создаёт набор перечислений с тем же типом элементов, что и указанный набор перечислений, изначально содержащий все элементы этого типа, которые не содержатся в указанном наборе.
`static <E extends Enum<E>> EnumSet<E>`	`copyOf(Collection<E> c)`	Создаёт набор перечислений, инициализированный из указанной коллекции.
`static <E extends Enum<E>> EnumSet<E>`	`copyOf(EnumSet<E> s)`	Создаёт набор перечислений с тем же типом элементов, что и указанный набор перечислений, изначально содержащий те же элементы (если есть).
`static <E extends Enum<E>> EnumSet<E>`	`noneOf(Class<E> elementType)`	Создаёт пустой набор перечислений с указанным типом элементов.
`static <E extends Enum<E>> EnumSet<E>`	`of(E e)`	Создаёт набор перечислений, изначально содержащий указанный элемент.
`static <E extends Enum<E>> EnumSet<E>`	`of(E e1, E e2)`	Создаёт набор перечислений, изначально содержащий указанные элементы.
`static <E extends Enum<E>> EnumSet<E>`	`of(E first, E... rest)`	Создаёт набор перечислений, изначально содержащий указанные элементы.
`static <E extends Enum<E>> EnumSet<E>`	`of(E e1, E e2, E e3)`	Создаёт набор перечислений, изначально содержащий указанные элементы.
`static <E extends Enum<E>> EnumSet<E>`	`of(E e1, E e2, E e3, E e4)`	Создаёт набор перечислений, изначально содержащий указанные элементы.
`static <E extends Enum<E>> EnumSet<E>`	`of(E e1, E e2, E e3, E e4, E e5)`	Создаёт набор перечислений, изначально содержащий указанные элементы.
`static <E extends Enum<E>> EnumSet<E>`	`range(E from, E to)`	Создаёт набор перечислений, изначально содержащий все элементы в диапазоне, определённом двумя указанными конечными точками.

Методы, объявленные в классе java.util.AbstractSet

equals, hashCode, removeAll

Методы, объявленные в классе java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, retainAll, toArray, toArray, toString

Методы, объявленные в классе java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе java.util.Collection

parallelStream, removeIf, stream, toArray

Методы, объявленные в интерфейсе java.lang.Iterable

forEach

Методы, объявленные в интерфейсе java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, retainAll, size, spliterator, toArray, toArray

Краткое описание методов

noneOf

public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType)

Создаёт пустое множество перечислений с указанным типом элементов.

Параметры типа:: E - Класс элементов в множестве
Параметры:: elementType - Объект класса типа элемента для этого множества перечислений
Возвращает:: Пустое множество перечислений указанного типа.
Исключения:: NullPointerException - если elementType является null

allOf

public static <E extends Enum<E>> EnumSet<E> allOf(Class<E> elementType)

Создаёт множество перечислений, содержащее все элементы указанного типа элементов.

Параметры типа:: E - Класс элементов в множестве
Параметры:: elementType - Объект класса типа элемента для этого множества перечислений
Возвращает:: Множество перечислений, содержащее все элементы указанного типа.
Исключения:: NullPointerException - если elementType является null

copyOf

public static <E extends Enum<E>> EnumSet<E> copyOf(EnumSet<E> s)

Создаёт множество перечислений с тем же типом элементов, что и указанное множество перечислений, первоначально содержащее те же элементы (если таковые имеются).

Параметры типа:: E - Класс элементов в множестве
Параметры:: s - множество перечислений, из которого нужно инициализировать это множество перечислений
Возвращает:: Копия указанного множества перечислений.
Исключения:: NullPointerException - если s является null

copyOf

public static <E extends Enum<E>> EnumSet<E> copyOf(Collection<E> c)

Создаёт множество перечислений, инициализированное из указанной коллекции. Если указанная коллекция является экземпляром EnumSet, этот статический фабричный метод ведет себя идентично copyOf(EnumSet). В противном случае указанная коллекция должна содержать как минимум один элемент (для определения типа элемента нового множества перечислений).

Параметры типа:: E - Класс элементов в коллекции
Параметры:: c - коллекция, из которой нужно инициализировать это множество перечислений
Возвращает:: Множество перечислений, инициализированное из данной коллекции.
Исключения:: IllegalArgumentException - если c не является экземпляром EnumSet и не содержит элементов; NullPointerException - если c является null

complementOf

public static <E extends Enum<E>> EnumSet<E> complementOf(EnumSet<E> s)

Создаёт множество перечислений с тем же типом элементов, что и указанное множество перечислений, первоначально содержащее все элементы этого типа, которые не содержатся в указанном множестве.

Параметры типа:: E - Класс элементов в множестве перечислений
Параметры:: s - множество перечислений, из дополнения которого нужно инициализировать это множество перечислений
Возвращает:: Дополнение указанного множества в этом множестве
Исключения:: NullPointerException - если s является null

of

public static <E extends Enum<E>> EnumSet<E> of(E e)

Создаёт множество перечислений, первоначально содержащее указанный элемент. Существуют перегрузки этого метода для инициализации множества перечислений от одного до пяти элементов. Предоставляется шестая перегрузка, которая использует функцию varargs. Эта перегрузка может использоваться для создания множества перечислений, первоначально содержащего произвольное количество элементов, но, вероятно, будет работать медленнее, чем перегрузки, которые не используют varargs.

Параметры типа:: E - Класс указанного элемента и множества
Параметры:: e - элемент, который это множество должно содержать первоначально
Возвращает:: множество перечислений, первоначально содержащее указанный элемент
Исключения:: NullPointerException - если e является null

of

public static <E extends Enum<E>> EnumSet<E> of(E e1, E e2)

Создаёт множество перечислений, первоначально содержащее указанные элементы. Существуют перегрузки этого метода для инициализации множества перечислений от одного до пяти элементов. Предоставляется шестая перегрузка, которая использует функцию varargs. Эта перегрузка может использоваться для создания множества перечислений, первоначально содержащего произвольное количество элементов, но, вероятно, будет работать медленнее, чем перегрузки, которые не используют varargs.

Параметры типа:: E - Класс элементов параметра и множества
Параметры:: e1 - элемент, который это множество должно содержать первоначально; e2 - ещё один элемент, который это множество должно содержать первоначально
Возвращает:: множество перечислений, первоначально содержащее указанные элементы
Исключения:: NullPointerException - если любой из параметров является null

of

public static <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3)

Параметры типа:: E - Класс элементов параметра и множества
Параметры:: e1 - элемент, который это множество должно содержать первоначально; e2 - ещё один элемент, который это множество должно содержать первоначально; e3 - ещё один элемент, который это множество должно содержать первоначально
Возвращает:: множество перечислений, первоначально содержащее указанные элементы
Исключения:: NullPointerException - если любой из параметров является null

of

public static <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3, E e4)

Параметры типа:: E - Класс элементов параметра и множества
Параметры:: e1 - элемент, который это множество должно содержать первоначально; e2 - ещё один элемент, который это множество должно содержать первоначально; e3 - ещё один элемент, который это множество должно содержать первоначально; e4 - ещё один элемент, который это множество должно содержать первоначально
Возвращает:: множество перечислений, первоначально содержащее указанные элементы
Исключения:: NullPointerException - если любой из параметров является null

of

public static <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3, E e4, E e5)

Параметры типа:: E - Класс элементов параметра и множества
Параметры:: e1 - элемент, который это множество должно содержать первоначально; e2 - ещё один элемент, который это множество должно содержать первоначально; e3 - ещё один элемент, который это множество должно содержать первоначально; e4 - ещё один элемент, который это множество должно содержать первоначально; e5 - ещё один элемент, который это множество должно содержать первоначально
Возвращает:: множество перечислений, первоначально содержащее указанные элементы
Исключения:: NullPointerException - если любой из параметров является null

of

@SafeVarargs public static <E extends Enum<E>> EnumSet<E> of(E first, E... rest)

Создаёт множество перечислений, первоначально содержащее указанные элементы. Этот фабричный метод, список параметров которого использует функцию varargs, может использоваться для создания множества перечислений, первоначально содержащего произвольное количество элементов, но, вероятно, будет работать медленнее, чем перегрузки, которые не используют varargs.

Параметры типа:: E - Класс элементов параметра и множества
Параметры:: first - элемент, который множество должно содержать первоначально; rest - остальные элементы, которые множество должно содержать первоначально
Возвращает:: множество перечислений, первоначально содержащее указанные элементы
Исключения:: NullPointerException - если любой из указанных элементов является null, или если rest является null

range

public static <E extends Enum<E>> EnumSet<E> range(E from, E to)

Создаёт множество перечислений, первоначально содержащее все элементы в диапазоне, определённом двумя указанными конечными точками. Возвращаемое множество будет содержать сами конечные точки, которые могут быть идентичными, но не должны быть расположены в неправильном порядке.

Параметры типа:: E - Класс элементов параметра и множества
Параметры:: from - первый элемент в диапазоне; to - последний элемент в диапазоне
Возвращает:: множество перечислений, первоначально содержащее все элементы в диапазоне, определённом двумя указанными конечными точками
Исключения:: NullPointerException - если from или to являются null; IllegalArgumentException - если from.compareTo(to) > 0

клонировать

public EnumSet<E> clone()

Возвращает копию этого набора.

Переопределяет:

clone в классе Object

Возвращает:

копию этого набора

См. также:

Cloneable

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/EnumSet.html