CopyOnWriteArraySet (Платформа Java SE 8 b92)

java.lang. Объект
- java.util. AbstractCollection<E>
- - java.util. AbstractSet <E>
  - - java.util.concurrent.CopyOnWriteArraySet<E>

Введите Параметры:

E - тип элементов сохранен в этом наборе

Все Реализованные Интерфейсы:

Сериализуемый, Повторяемый <E>, Набор <E>, Набор <E>
```
public class CopyOnWriteArraySet<E>
extends AbstractSet<E>
implements Serializable
```
A Set это использует внутреннее CopyOnWriteArrayList для всех его операций. Таким образом это совместно использует те же самые основные свойства:
- Это лучше всего подходит для приложений, в которых обычно остаются размеры набора, маленькие, операции только для чтения значительно превосходят численностью изменчивые операции, и Вы должны предотвратить интерференцию среди потоков во время обхода.
- Это ориентировано на многопотоковое исполнение.
- Изменчивые операции (add, set, remove, и т.д.) дороги, так как они обычно влекут за собой копирование всего базового массива.
- Iterators не поддерживают изменчивую работу remove.
- Обход через iterators быстр и не может встретиться с интерференцией от других потоков. Iterators полагаются на неизменные снимки массива в то время, когда iterators были созданы.
Демонстрационное Использование. Следующий эскиз кода использует набор копии на записи, чтобы поддержать ряд Объектов-обработчиков, которые выполняют некоторое действие после обновлений состояния.
```
 
 class Handler { void handle(); ... }

 class X {
   private final CopyOnWriteArraySet<Handler> handlers
     = new CopyOnWriteArraySet<Handler>();
   public void addHandler(Handler h) { handlers.add(h); }

   private long internalState;
   private synchronized void changeState() { internalState = ...; }

   public void update() {
     changeState();
     for (Handler handler : handlers)
        handler.handle();
   }
 }
```
Этот class является элементом Платформы Наборов Java.
С тех пор:

1.5

См. Также:

CopyOnWriteArrayList, Сериализированная Форма

Сводка конструктора

Конструкторы
Конструктор и Описание
`CopyOnWriteArraySet()` Создает пустое множество.
`CopyOnWriteArraySet(Collection<? extends E> c)` Создает набор, содержащий все элементы указанного набора.

Сводка метода

Все Методы Методы экземпляра Конкретные Методы
Модификатор и Тип	Метод и Описание
`boolean`	`add(E e)` Добавляет указанный элемент к этому набору, если это уже не присутствует.
`boolean`	`addAll(Collection<? extends E> c)` Добавляют все элементы в указанном наборе к этому набору, если они уже не присутствуют.
`void`	`clear()` Удаляет все элементы от этого набора.
`boolean`	`contains(Object o)` `true` возвратов, если этот набор содержит указанный элемент.
`boolean`	`containsAll(Collection<?> c)` `true` возвратов, если этот набор содержит все элементы указанного набора.
`boolean`	`equals(Object o)` Сравнивает указанный объект с этим набором для равенства.
`boolean`	`isEmpty()` `true` возвратов, если этот набор не содержит элементов.
`Iterator<E>`	`iterator()` Возвращает iterator по элементам, содержавшимся в этом наборе в порядке, в котором были добавлены эти элементы.
`boolean`	`remove(Object o)` Удаляет указанный элемент из этого набора, если это присутствует.
`boolean`	`removeAll(Collection<?> c)` Удаляет из этого набора все его элементы, которые содержатся в указанном наборе.
`boolean`	`retainAll(Collection<?> c)` Сохраняет только элементы в этом наборе, которые содержатся в указанном наборе.
`int`	`size()` Возвращает число элементов в этом наборе.
`Объект[]`	`toArray()` Возвращает массив, содержащий все элементы в этом наборе.
`<T> T[]`	`toArray(T[] a)` Возвращает массив, содержащий все элементы в этом наборе; тип времени выполнения возвращенного массива является типом указанного массива.

Методы, наследованные от class java.util. AbstractSet
хэш-код

Методы, наследованные от class java.util. AbstractCollection
toString

Методы, наследованные от class java.lang. Объект
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Методы, наследованные от интерфейса java.util. Набор
spliterator

Методы, наследованные от интерфейса java.util. Набор
parallelStream, removeIf, stream

Методы, наследованные от интерфейса java.lang. Повторяемый
forEach

- Деталь конструктора
  - CopyOnWriteArraySet
```
public CopyOnWriteArraySet()
```
    Создает пустое множество.
  - CopyOnWriteArraySet
```
public CopyOnWriteArraySet(Collection<? extends E> c)
```
    Создает набор, содержащий все элементы указанного набора.
    
    Параметры:
    
    c - набор элементов, чтобы первоначально содержать
    
    Броски:
    
    NullPointerException - если указанный набор является нулем
- Деталь метода
  - размер
```
public int size()
```
    Возвращает число элементов в этом наборе.
    
    Определенный:
    
    size в интерфейсе Collection<E>
    
    Определенный:
    
    size в интерфейсе Set<E>
    
    Определенный:
    
    size в class AbstractCollection<E>
    
    Возвраты:
    
    число элементов в этом наборе
  - isEmpty
```
public boolean isEmpty()
```
    true возвратов, если этот набор не содержит элементов.
    
    Определенный:
    
    isEmpty в интерфейсе Collection<E>
    
    Определенный:
    
    isEmpty в интерфейсе Set<E>
    
    Переопределения:
    
    isEmpty в class AbstractCollection<E>
    
    Возвраты:
    
    true, если этот набор не содержит элементов
  - содержит
```
public boolean contains(Object o)
```
    true возвратов, если этот набор содержит указанный элемент. Более формально, возвраты true, если и только если этот набор содержит элемент e так, что (o==null ? e==null : o.equals(e)).
    
    Определенный:
    
    contains в интерфейсе Collection<E>
    
    Определенный:
    
    contains в интерфейсе Set<E>
    
    Переопределения:
    
    contains в class AbstractCollection<E>
    
    Параметры:
    
    o - элемент, присутствие которого в этом наборе должно быть протестировано
    
    Возвраты:
    
    true, если этот набор содержит указанный элемент
  - toArray
```
public Object[] toArray()
```
    Возвращает массив, содержащий все элементы в этом наборе. Если этот набор делает какие-либо гарантии относительно того, какой порядок его элементы возвращаются его iterator, этот метод должен возвратить элементы в том же самом порядке.
    Возвращенный массив будет "безопасен" в этом, никакие ссылки на него не сохраняются этим набором. (Другими словами этот метод должен выделить новый массив, даже если этот набор поддерживается массивом). Вызывающая сторона таким образом свободна изменить возвращенный массив.
    Этот метод действует как мост между основанными на массиве и основанными на наборе API.
    
    Определенный:
    
    toArray в интерфейсе Collection<E>
    
    Определенный:
    
    toArray в интерфейсе Set<E>
    
    Переопределения:
    
    toArray в class AbstractCollection<E>
    
    Возвраты:
    
    массив, содержащий все элементы в этом наборе
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Возвращает массив, содержащий все элементы в этом наборе; тип времени выполнения возвращенного массива является типом указанного массива. Если набор помещается в указанный массив, он возвращается туда. Иначе, новый массив выделяется с типом времени выполнения указанного массива и размером этого набора.
    Если этот набор помещается в указанный массив с комнатой, чтобы сэкономить (то есть, у массива есть больше элементов чем этот набор), элемент в массиве сразу после конца набора устанавливается в null. (Это полезно в определении длины этого набора, только если вызывающая сторона знает, что этот набор не содержит нулевых элементов.)
    Если этот набор делает какие-либо гарантии относительно того, какой порядок его элементы возвращаются его iterator, этот метод должен возвратить элементы в том же самом порядке.
    Как toArray() метод, этот метод действует как мост между основанными на массиве и основанными на наборе API. Далее, этот метод позволяет точное управление типом времени выполнения выходного массива, и, при определенных обстоятельствах, может использоваться, чтобы сохранить затраты выделения.
    Предположите, что x является набором, который, как известно, содержал только строки. Следующий код может использоваться, чтобы вывести набор в недавно выделенный массив String:
```
  String[] y = x.toArray(new String[0]);
```
    Отметьте, что toArray(new Object[0]) идентичен в функции toArray().
    Определенный:
    
    toArray в интерфейсе Collection<E>
    
    Определенный:
    
    toArray в интерфейсе Set<E>
    
    Переопределения:
    
    toArray в class AbstractCollection<E>
    
    Параметры:
    
    a - массив, в который должны быть сохранены элементы этого набора, если это является достаточно большим; иначе, новый массив того же самого типа времени выполнения выделяется с этой целью.
    
    Возвраты:
    
    массив, содержащий все элементы в этом наборе
    
    Броски:
    
    ArrayStoreException - если тип времени выполнения указанного массива не является супертипом типа времени выполнения каждого элемента в этом наборе
    
    NullPointerException - если указанный массив является нулем
  - очистить
```
public void clear()
```
    Удаляет все элементы от этого набора. Набор будет пуст после этого вызова возвраты.
    
    Определенный:
    
    clear в интерфейсе Collection<E>
    
    Определенный:
    
    clear в интерфейсе Set<E>
    
    Переопределения:
    
    clear в class AbstractCollection<E>
  - удалить
```
public boolean remove(Object o)
```
    Удаляет указанный элемент из этого набора, если это присутствует. Более формально, удаляет элемент e так, что (o==null ? e==null : o.equals(e)), если этот набор содержит такой элемент. Возвраты true, если этот набор, содержавший элемент (или эквивалентно, если этот набор, измененный в результате вызова). (Этот набор не будет содержать элемент, как только вызов возвращается.)
    
    Определенный:
    
    remove в интерфейсе Collection<E>
    
    Определенный:
    
    remove в интерфейсе Set<E>
    
    Переопределения:
    
    remove в class AbstractCollection<E>
    
    Параметры:
    
    o - объект, который будет удален из этого набора, если существующий
    
    Возвраты:
    
    true, если этот набор, содержавший указанный элемент
  - добавить
```
public boolean add(E e)
```
    Добавляет указанный элемент к этому набору, если это уже не присутствует. Более формально добавляет указанный элемент e к этому набору, если набор не содержит элемента e2 так, что (e==null ? e2==null : e.equals(e2)). Если этот набор уже содержит элемент, листы вызова неизменный набор и возвращает false.
    
    Определенный:
    
    add в интерфейсе Collection<E>
    
    Определенный:
    
    add в интерфейсе Set<E>
    
    Переопределения:
    
    add в class AbstractCollection<E>
    
    Параметры:
    
    e - элемент, который будет добавлен к этому набору
    
    Возвраты:
    
    true, если этот набор уже не содержал указанный элемент
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    true возвратов, если этот набор содержит все элементы указанного набора. Если указанный набор является также набором, этот метод возвращает true, если это - подмножество этого набора.
    
    Определенный:
    
    containsAll в интерфейсе Collection<E>
    
    Определенный:
    
    containsAll в интерфейсе Set<E>
    
    Переопределения:
    
    containsAll в class AbstractCollection<E>
    
    Параметры:
    
    c - набор, который будет проверен на включение в этом наборе
    
    Возвраты:
    
    true, если этот набор содержит все элементы указанного набора
    
    Броски:
    
    NullPointerException - если указанный набор является нулем
    
    См. Также:
    
    contains(Object)
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Добавляют все элементы в указанном наборе к этому набору, если они уже не присутствуют. Если указанный набор является также набором, работа addAll эффективно изменяет этот набор так, чтобы его значение было объединением двух наборов. Поведение этой работы неопределено, если указанный набор изменяется, в то время как работа происходит.
    
    Определенный:
    
    addAll в интерфейсе Collection<E>
    
    Определенный:
    
    addAll в интерфейсе Set<E>
    
    Переопределения:
    
    addAll в class AbstractCollection<E>
    
    Параметры:
    
    c - набор, содержащий элементы, которые будут добавлены к этому набору
    
    Возвраты:
    
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    NullPointerException - если указанный набор является нулем
    
    См. Также:
    
    add(Object)
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Удаляет из этого набора все его элементы, которые содержатся в указанном наборе. Если указанный набор является также набором, эта работа эффективно изменяет этот набор так, чтобы его значение было асимметричной разностью множеств двух наборов.
    
    Определенный:
    
    removeAll в интерфейсе Collection<E>
    
    Определенный:
    
    removeAll в интерфейсе Set<E>
    
    Переопределения:
    
    removeAll в class AbstractSet<E>
    
    Параметры:
    
    c - набор, содержащий элементы, которые будут удалены из этого набора
    
    Возвраты:
    
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    ClassCastException - если class элемента этого набора является несовместимым с указанным (дополнительным) набором
    
    NullPointerException - если этот набор содержит нулевой элемент, и указанный набор не разрешает нулевые (дополнительные) элементы, или если указанный набор является нулем
    
    См. Также:
    
    remove(Object)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Сохраняет только элементы в этом наборе, которые содержатся в указанном наборе. Другими словами, удаляет из этого набора все его элементы, которые не содержатся в указанном наборе. Если указанный набор является также набором, эта работа эффективно изменяет этот набор так, чтобы его значение было пересечением двух наборов.
    
    Определенный:
    
    retainAll в интерфейсе Collection<E>
    
    Определенный:
    
    retainAll в интерфейсе Set<E>
    
    Переопределения:
    
    retainAll в class AbstractCollection<E>
    
    Параметры:
    
    c - набор, содержащий элементы, которые будут сохранены в этом наборе
    
    Возвраты:
    
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    ClassCastException - если class элемента этого набора является несовместимым с указанным (дополнительным) набором
    
    NullPointerException - если этот набор содержит нулевой элемент, и указанный набор не разрешает нулевые (дополнительные) элементы, или если указанный набор является нулем
    
    См. Также:
    
    remove(Object)
  - iterator
```
public Iterator<E> iterator()
```
    Возвращает iterator по элементам, содержавшимся в этом наборе в порядке, в котором были добавлены эти элементы.
    Возвращенный iterator обеспечивает снимок состояния набора, когда iterator был создан. Никакая синхронизация не необходима, пересекая iterator. iterator НЕ поддерживает метод remove.
    
    Определенный:
    
    iterator в интерфейсе Iterable<E>
    
    Определенный:
    
    iterator в интерфейсе Collection<E>
    
    Определенный:
    
    iterator в интерфейсе Set<E>
    
    Определенный:
    
    iterator в class AbstractCollection<E>
    
    Возвраты:
    
    iterator по элементам в этом наборе
  - равняется
```
public boolean equals(Object o)
```
    Сравнивает указанный объект с этим набором для равенства. Возвраты true если указанный объект является тем же самым объектом как этот объект, или если это также a Set и элементы, возвращенные iterator по указанному набору, являются тем же самым как элементами, возвращенными iterator по этому набору. Более формально два iterators, как полагают, возвращают те же самые элементы, если они возвращают то же самое число элементов и для каждого элемента e1 возвращенный iterator по указанному набору, есть элемент e2 возвращенный iterator по этому набору так, что (e1==null ? e2==null : e1.equals(e2)).
    
    Определенный:
    
    equals в интерфейсе Collection<E>
    
    Определенный:
    
    equals в интерфейсе Set<E>
    
    Переопределения:
    
    equals в class AbstractSet<E>
    
    Параметры:
    
    o - объект, который будет сравнен для равенства с этим набором
    
    Возвраты:
    
    true если указанный объект равен этому набору
    
    См. Также:
    
    Object.hashCode(), HashMap

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2013, Oracle и/или его филиалы. Все права защищены.
Проект сборка-b92

Класс CopyOnWriteArraySet <E>

Сводка конструктора

Сводка метода

Методы, наследованные от class java.util. AbstractSet

Методы, наследованные от class java.util. AbstractCollection

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

Методы, наследованные от интерфейса java.util. Набор

Методы, наследованные от интерфейса java.util. Набор

Методы, наследованные от интерфейса java.lang. Повторяемый

Деталь конструктора

CopyOnWriteArraySet

CopyOnWriteArraySet

Деталь метода

размер

isEmpty

содержит

toArray

toArray

очистить

удалить

добавить

containsAll

addAll

removeAll

retainAll

iterator

равняется