Интерфейс Set<E>

int size()

Указано в:

size в интерфейсе Collection<E>

Возвращает:

количество элементов в этом множестве (его мощность)

boolean isEmpty()

Указано в:

isEmpty в интерфейсе Collection<E>

Возвращает:

true, если это множество не содержит элементов

boolean contains(Object o)

Указано в:

contains в интерфейсе Collection<E>

Параметры:

o — элемент, наличие которого в этом множестве проверяется

Возвращает:

true, если это множество содержит указанный элемент

Вызывает:

ClassCastException — если тип указанного элемента несовместим с этим множеством (необязательно)

NullPointerException — если указанный элемент равен null, а это множество не допускает элементы null (необязательно)

Iterator<E> iterator()

Указано в:

iterator в интерфейсе Collection<E>

Указано в:

iterator в интерфейсе Iterable<E>

Возвращает:

итератор по элементам этого множества

Object[] toArray()

Указано в:

toArray в интерфейсе Collection<E>

Возвращает:

массив, содержащий все элементы этого множества

<T> T[] toArray(T[] a)

    String[] y = x.toArray(new String[0]);

Указано в:

toArray в интерфейсе Collection<E>

Параметры типа:

T — тип компонента массива, в котором будет храниться коллекция

Параметры:

a — массив, в котором будут храниться элементы этого множества, если он достаточно велик; в противном случае для этой цели выделяется новый массив того же типа во время выполнения.

Возвращает:

массив, содержащий все элементы этого множества

Вызывает:

ArrayStoreException — если тип указанного массива во время выполнения не является супертипом типа во время выполнения каждого элемента этого множества

NullPointerException — если указанный массив равен null

boolean add(E e)

Указано в:

add в интерфейсе Collection<E>

Параметры:

e — элемент, который нужно добавить в это множество

Возвращает:

true, если это множество ещё не содержало указанный элемент

Вызывает:

UnsupportedOperationException — если операция add не поддерживается этим множеством

ClassCastException — если класс указанного элемента препятствует его добавлению в это множество

NullPointerException — если указанный элемент равен null, а это множество не допускает элементы null

IllegalArgumentException — если какое-либо свойство указанного элемента препятствует его добавлению в это множество

boolean remove(Object o)

Указано в:

remove в интерфейсе Collection<E>

Параметры:

o — объект, который нужно удалить из этого множества, если он присутствует

Возвращает:

true, если это множество содержало указанный элемент

Вызывает:

ClassCastException — если тип указанного элемента несовместим с этим множеством (необязательно)

NullPointerException — если указанный элемент равен null, а это множество не допускает элементы null (необязательно)

UnsupportedOperationException — если операция remove не поддерживается этим множеством

boolean containsAll(Collection<?> c)

Указано в:

containsAll в интерфейсе Collection<E>

Параметры:

c — коллекция, наличие элементов которой в этом множестве проверяется

Возвращает:

true, если это множество содержит все элементы указанной коллекции

Вызывает:

ClassCastException — если типы одного или нескольких элементов указанной коллекции несовместимы с этим множеством (необязательно)

NullPointerException — если указанная коллекция содержит один или несколько элементов null, а это множество не допускает элементы null (необязательно), либо если указанная коллекция равна null

См. также:

• contains(Object)

boolean addAll(Collection<? extends E> c)

Указано в:

addAll в интерфейсе Collection<E>

Параметры:

c — коллекция, содержащая элементы для добавления в это множество

Возвращает:

true, если это множество изменилось в результате вызова

Вызывает:

UnsupportedOperationException — если операция addAll не поддерживается этим множеством

ClassCastException — если класс элемента указанной коллекции препятствует его добавлению в это множество

NullPointerException — если указанная коллекция содержит один или несколько элементов null, а это множество не допускает элементы null, либо если указанная коллекция равна null

IllegalArgumentException — если какое-либо свойство элемента указанной коллекции препятствует его добавлению в это множество

См. также:

• add(Object)

boolean retainAll(Collection<?> c)

Указано в:

retainAll в интерфейсе Collection<E>

Параметры:

c — коллекция, содержащая элементы, которые нужно оставить в этом множестве

Возвращает:

true, если это множество изменилось в результате вызова

Вызывает:

UnsupportedOperationException — если операция retainAll не поддерживается этим множеством

ClassCastException — если класс элемента этого множества несовместим с указанной коллекцией (необязательно)

NullPointerException — если это множество содержит элемент null, а указанная коллекция не допускает элементы null (необязательно), либо если указанная коллекция равна null

См. также:

• remove(Object)

boolean removeAll(Collection<?> c)

Указано в:

removeAll в интерфейсе Collection<E>

Параметры:

c — коллекция, содержащая элементы для удаления из этого множества

Возвращает:

true, если это множество изменилось в результате вызова

Вызывает:

UnsupportedOperationException — если операция removeAll не поддерживается этим множеством

ClassCastException — если класс элемента этого множества несовместим с указанной коллекцией (необязательно)

NullPointerException — если это множество содержит элемент null, а указанная коллекция не допускает элементы null (необязательно), либо если указанная коллекция равна null

См. также:

• remove(Object)
• contains(Object)

void clear()

Указано в:

clear в интерфейсе Collection<E>

Вызывает:

UnsupportedOperationException — если метод clear не поддерживается этим множеством

boolean equals(Object o)

Указано в:

equals в интерфейсе Collection<E>

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

equals в классе Object

Параметры:

o — объект, который сравнивается на равенство с этим множеством

Возвращает:

true, если указанный объект равен этому множеству

См. также:

• Object.equals(Object)
• equals(Object)
• List.equals(Object)

int hashCode()

Указано в:

hashCode в интерфейсе Collection<E>

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

hashCode в классе Object

Возвращает:

значение хеш-кода этого множества

См. также:

• Object.equals(Object)
• equals(Object)

default Spliterator<E> spliterator()

Указано в:

spliterator в интерфейсе Collection<E>

Указано в:

spliterator в интерфейсе Iterable<E>

Требования к реализации:

Реализация по умолчанию создаёт сплитератор с отложенной привязкой на основе Iterator множества. Сплитератор наследует свойства итератора множества, связанные с обнаружением изменений.

Созданный Spliterator дополнительно сообщает о характеристике Spliterator.SIZED.

Примечание к реализации:

Созданный Spliterator дополнительно сообщает о характеристике Spliterator.SUBSIZED.

Возвращает:

Spliterator для элементов этого множества

Начиная с:

1.8

static <E> Set<E> of()

Параметры типа:

E — тип элемента Set

Возвращает:

пустое Set

Начиная с:

9

static <E> Set<E> of(E e1)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — единственный элемент

Возвращает:

Set, содержащее указанный элемент

Вызывает:

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если элементы являются дубликатами

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4, E e5)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

e5 — пятый элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4, E e5, E e6)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

e5 — пятый элемент

e6 — шестой элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E e7)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

e5 — пятый элемент

e6 — шестой элемент

e7 — седьмой элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

e5 — пятый элемент

e6 — шестой элемент

e7 — седьмой элемент

e8 — восьмой элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9)

Параметры типа:

E — тип элемента Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

e5 — пятый элемент

e6 — шестой элемент

e7 — седьмой элемент

e8 — восьмой элемент

e9 — девятый элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент равен null

Начиная с:

9

static <E> Set<E> of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10)

Параметры типа:

E — тип элементов Set

Параметры:

e1 — первый элемент

e2 — второй элемент

e3 — третий элемент

e4 — четвёртый элемент

e5 — пятый элемент

e6 — шестой элемент

e7 — седьмой элемент

e8 — восьмой элемент

e9 — девятый элемент

e10 — десятый элемент

Возвращает:

Set, содержащее указанные элементы

Вызывает исключение:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент null

Начиная с:

9

@SafeVarargs static <E> Set<E> of(E... elements)

Примечание API:

Этот метод также принимает в качестве аргумента один массив. Тип элементов результирующего множества будет соответствовать типу компонентов массива, а размер множества будет равен длине массива. Чтобы создать множество с единственным элементом, которым является массив, выполните следующее:

    String[] array = ... ;
    Set<String[]> list = Set.<String[]>of(array);

В этом случае будет вызван метод Set.of(E).

Параметры типа:

E — тип элементов Set

Параметры:

elements — элементы, которые будут содержаться в множестве

Возвращает:

Set, содержащее указанные элементы

Вызывает исключение:

IllegalArgumentException — если имеются повторяющиеся элементы

NullPointerException — если элемент null или массив null

Начиная с:

9

static <E> Set<E> copyOf(Collection<? extends E> coll)

Примечание по реализации:

Если указанная коллекция является неизменяемым множеством, вызов copyOf обычно не создаёт копию.

Параметры типа:

E — тип элементов Set

Параметры:

coll — Collection, из которой берутся элементы; не должна быть null

Возвращает:

Set, содержащее элементы указанной Collection

Вызывает исключение:

NullPointerException — если coll равно null или содержит значения null

Начиная с:

10

static <E> Set<E> ofLazy(Set<? extends E> elementCandidates, Predicate<? super E> computingFunction)

class Application {

    enum Option {VERBOSE, DRY_RUN, STRICT}

    // Lazily initialized Set of Options
    static final Set<Option> OPTIONS =
            Set.ofLazy(EnumSet.allOf(Option.class), Application::isEnabled);

    // Return true when the given Option is enabled
    private static boolean isEnabled(Option option) {
        // Parse command line, read configuration file, load database
        ...
    }

    public static void process() {
        // The if condition (and subsequent eliminated branch) is
        // eligible for constant folding (and code elimination).
        if (OPTIONS.contains(Option.DRY_RUN)) {
            // Skip processing in DRY_RUN mode
            return;
        }
        // Actual processing logic
    }

}

 class LazySet<E> extends AbstractCollection<E> implements Set<E> {

     private final Map<E, LazyConstant<Boolean>> backingMap;

     public LazySet(Set<E> elementCandidates, Predicate<E> computingFunction) {
         this.backingMap = elementCandidates.stream()
                 .collect(Collectors.toUnmodifiableMap(
                         Function.identity(),
                         k -> LazyConstant.of(() -> computingFunction.test(k))));
     }

     @Override
     public boolean contains(Object o) {
         var lazyConstant = backingMap.get(o);
         return lazyConstant == null
                 ? false
                 : lazyConstant.get();
     }
 }

Примечание по реализации:

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

Параметры типа:

E — тип элементов, хранящихся в возвращённом множестве

Параметры:

elementCandidates — кандидаты на элементы, подлежащие оценке (не должны быть null)

computingFunction — вызывается при первом вычислении статуса принадлежности кандидата на элемент

Возвращает:

новое множество с ленивыми вычислениями, логическая принадлежность каждого отдельного кандидата на элемент в наборе elementCandidates которого вычисляется по запросу с помощью предоставленного computingFunction

Вызывает исключение:

NullPointerException — если предоставленное множество elementCandidates равно null, если множество elementCandidates содержит элемент null или если предоставленный computingFunction равен null

Начиная с:

27

См. также:

• LazyConstant^{ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ}