AbstractCollection (Платформа Java SE 7)

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

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

Повторяемый <E>, Набор <E>

Прямые Известные Подклассы:

AbstractList, AbstractQueue, AbstractSet, ArrayDeque, ConcurrentLinkedDeque
```
public abstract class AbstractCollection<E>
extends Object
implements Collection<E>
```
Этот класс обеспечивает скелетную реализацию интерфейса Collection, чтобы минимизировать усилие, требуемое реализовывать этот интерфейс.
Чтобы реализовать неподдающийся изменению набор, программист должен только расширить этот класс и обеспечить реализации для методов iterator И size. (iterator, возвращенный методом iterator, должен реализовать hasNext и next.)
Чтобы реализовать поддающийся изменению набор, программист должен дополнительно переопределить метод add этого класса (который иначе бросает UnsupportedOperationException), и iterator, возвращенный методом iterator, должен дополнительно реализовать свой метод remove.
Программист должен обычно обеспечить пустоту (никакой параметр) и конструктор Collection согласно рекомендации в спецификации интерфейса Collection.
Документация для каждого неабстрактного метода в этом классе описывает свою реализацию подробно. Каждый из этих методов может быть переопределен, если реализовываемый набор допускает более эффективную реализацию.
Этот класс является элементом Платформы Наборов Java.

С тех пор:

1.2

См. Также:
Collection

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

Конструкторы
Модификатор Конструктор и Описание

protected AbstractCollection()
Единственный конструктор.

Конструкторы
Модификатор	Конструктор и Описание
`protected`	`AbstractCollection()` Единственный конструктор.

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

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

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

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

- Деталь конструктора
  - AbstractCollection
```
protected AbstractCollection()
```
    Единственный конструктор. (Для вызова конструкторами подкласса, обычно неявными.)
- Деталь метода
  - iterator
```
public abstract Iterator<E> iterator()
```
    Возвращает iterator по элементам, содержавшимся в этом наборе.
    
    Определенный:
    
    iterator в интерфейсе Iterable<E>
    
    Определенный:
    
    iterator в интерфейсе Collection<E>
    
    Возвраты:
    iterator по элементам содержится в этом наборе
  - размер
```
public abstract int size()
```
    Описание скопировало с интерфейса: Collection
    
    Возвращает число элементов в этом наборе. Если этот набор содержит больше чем элементы Integer.MAX_VALUE, Integer.MAX_VALUE возвратов.
    
    Определенный:
    
    size в интерфейсе Collection<E>
    
    Возвраты:
    число элементов в этом наборе
  - isEmpty
```
public boolean isEmpty()
```
    true возвратов, если этот набор не содержит элементов.
    Эта реализация возвращает size() == 0.
    
    Определенный:
    
    isEmpty в интерфейсе Collection<E>
    
    Возвраты:
    true, если этот набор не содержит элементов
  - содержит
```
public boolean contains(Object o)
```
    true возвратов, если этот набор содержит указанный элемент. Более формально, возвраты true, если и только если этот набор содержит по крайней мере один элемент e так, что (o==null ? e==null : o.equals(e)).
    Эта реализация выполняет итерации по элементам в наборе, проверяя каждый элемент поочередно на равенство с указанным элементом.
    
    Определенный:
    
    contains в интерфейсе Collection<E>
    
    Параметры:
    o - элемент, присутствие которого в этом наборе должно быть протестировано
    
    Возвраты:
    true, если этот набор содержит указанный элемент
    
    Броски:
    
    ClassCastException - если тип указанного элемента является несовместимым с этим (дополнительным) набором
    
    NullPointerException - если указанный элемент является нулем, и этот набор не разрешает нулевые (дополнительные) элементы
  - toArray
```
public Object[] toArray()
```
    Возвращает массив, содержащий все элементы в этом наборе. Если этот набор делает какие-либо гарантии относительно того, какой порядок его элементы возвращаются его iterator, этот метод должен возвратить элементы в том же самом порядке.
    Возвращенный массив будет "безопасен" в этом, никакие ссылки на него не сохраняются этим набором. (Другими словами этот метод должен выделить новый массив, даже если этот набор поддерживается массивом). Вызывающая сторона таким образом свободна изменить возвращенный массив.
    Этот метод действует как мост между основанными на массиве и основанными на наборе API.
    Эта реализация возвращает массив, содержащий все элементы, возвращенные iterator этого набора, в том же самом порядке, сохраненном в последовательных элементах массива, запускающегося с индекса 0. Длина возвращенного массива равна числу элементов, возвращенному iterator, даже если размер этого набора изменяется во время итерации, как это могло бы произойти, если набор разрешает параллельную модификацию во время итерации. size метод вызывают только как подсказка оптимизации; корректный результат возвращается, даже если iterator возвращает различное число элементов.
    Этот метод эквивалентен:
```
 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray();
 
```
    Определенный:
    
    toArray в интерфейсе Collection<E>
    
    Возвраты:
    массив, содержащий все элементы в этом наборе
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Возвращает массив, содержащий все элементы в этом наборе; тип времени выполнения возвращенного массива является типом указанного массива. Если набор помещается в указанный массив, он возвращается туда. Иначе, новый массив выделяется с типом времени выполнения указанного массива и размером этого набора.
    Если этот набор помещается в указанный массив с комнатой, чтобы сэкономить (то есть, у массива есть больше элементов чем этот набор), элемент в массиве сразу после конца набора устанавливается в null. (Это полезно в определении длины этого набора, только если вызывающая сторона знает, что этот набор не содержит элементов null.)
    Если этот набор делает какие-либо гарантии относительно того, какой порядок его элементы возвращаются его iterator, этот метод должен возвратить элементы в том же самом порядке.
    Как Collection.toArray() метод, этот метод действует как мост между основанными на массиве и основанными на наборе API. Далее, этот метод позволяет точное управление типом времени выполнения выходного массива, и, при определенных обстоятельствах, может использоваться, чтобы сохранить затраты выделения.
    Предположите, что x является набором, который, как известно, содержал только строки. Следующий код может использоваться, чтобы вывести набор в недавно выделенный массив String:
```
     String[] y = x.toArray(new String[0]);
```
    Отметьте, что toArray(new Object[0]) идентичен в функции toArray().
    Эта реализация возвращает массив, содержащий все элементы, возвращенные iterator этого набора в том же самом порядке, сохраненном в последовательных элементах массива, запускающегося с индекса 0. Если число элементов, возвращенное iterator, является слишком большим, чтобы вписаться в указанный массив, то элементы возвращаются в недавно выделенном массиве с длиной, равной числу элементов, возвращенному iterator, даже если размер этого набора изменяется во время итерации, как это могло бы произойти, если набор разрешает параллельную модификацию во время итерации. size метод вызывают только как подсказка оптимизации; корректный результат возвращается, даже если iterator возвращает различное число элементов.
    Этот метод эквивалентен:
```
 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray(a);
 
```
    Определенный:
    
    toArray в интерфейсе Collection<E>
    
    Параметры:
    a - массив, в который должны быть сохранены элементы этого набора, если это является достаточно большим; иначе, новый массив того же самого типа времени выполнения выделяется с этой целью.
    
    Возвраты:
    массив, содержащий все элементы в этом наборе
    
    Броски:
    
    ArrayStoreException - если тип времени выполнения указанного массива не является супертипом типа времени выполнения каждого элемента в этом наборе
    
    NullPointerException - если указанный массив является нулем
  - добавить
```
public boolean add(E e)
```
    Гарантирует, что этот набор содержит указанный элемент (дополнительная работа). true возвратов, если этот набор изменился в результате вызова. (Возвраты false, если этот набор не разрешает копии и уже содержит указанный элемент.)
    Наборы, которые поддерживают эту работу, могут поместить ограничения на то, какие элементы могут быть добавлены к этому набору. В частности некоторые наборы откажутся добавить элементы null, и другие введут ограничения для типа элементов, которые могут быть добавлены. Классы набора должны ясно определить в их документации любые ограничения на то, какие элементы могут быть добавлены.
    Если набор отказывается добавить определенный элемент по какой-либо причине, кроме которой он уже содержит элемент, он должен выдать исключение (вместо того, чтобы возвратить false). Это сохраняет инвариант, что набор всегда содержит указанный элемент после этого вызова возвраты.
    Эта реализация всегда бросает UnsupportedOperationException.
    
    Определенный:
    
    add в интерфейсе Collection<E>
    
    Параметры:
    e - элемент, присутствие которого в этом наборе должно быть обеспечено
    
    Возвраты:
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    UnsupportedOperationException - если работа add не поддерживается этим набором
    
    ClassCastException - если класс указанного элемента препятствует тому, чтобы это было добавлено к этому набору
    
    NullPointerException - если указанный элемент является нулем, и этот набор не разрешает нулевые элементы
    
    IllegalArgumentException - если некоторое свойство элемента препятствует тому, чтобы это было добавлено к этому набору
    
    IllegalStateException - если элемент не может быть добавлен в это время из-за ограничений вставки
  - удалить
```
public boolean remove(Object o)
```
    Удаляет единственный экземпляр указанного элемента от этого набора, если это присутствует (дополнительная работа). Более формально, удаляет элемент e так, что (o==null ? e==null : o.equals(e)), если этот набор содержит один или более таких элементов. Возвраты true, если этот набор, содержавший указанный элемент (или эквивалентно, если этот набор, измененный в результате вызова).
    Эта реализация выполняет итерации по набору, ища указанный элемент. Если это находит элемент, это удаляет элемент из набора, используя iterator's, удаляют метод.
    Отметьте, что эта реализация бросает UnsupportedOperationException, если iterator, возвращенный iterator методом этого набора, не реализует метод remove, и этот набор содержит указанный объект.
    
    Определенный:
    
    remove в интерфейсе Collection<E>
    
    Параметры:
    o - элемент, который будет удален из этого набора, если существующий
    
    Возвраты:
    true, если элемент был удален в результате этого вызова
    
    Броски:
    
    UnsupportedOperationException - если работа remove не поддерживается этим набором
    
    ClassCastException - если тип указанного элемента является несовместимым с этим (дополнительным) набором
    
    NullPointerException - если указанный элемент является нулем, и этот набор не разрешает нулевые (дополнительные) элементы
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    true возвратов, если этот набор содержит все элементы в указанном наборе.
    Эта реализация выполняет итерации по указанному набору, проверяя каждый элемент, возвращенный iterator поочередно, чтобы видеть, содержится ли это в этом наборе. Если всеми элементами является так содержавший true, возвращается, иначе false.
    
    Определенный:
    
    containsAll в интерфейсе Collection<E>
    
    Параметры:
    c - набор, который будет проверен на включение в этом наборе
    
    Возвраты:
    true, если этот набор содержит все элементы в указанном наборе
    
    Броски:
    
    ClassCastException - если типы одного или более элементов в указанном наборе являются несовместимыми с этим (дополнительным) набором
    
    NullPointerException - если указанный набор содержит один или более нулевых элементов, и этот набор не разрешает нулевые (дополнительные) элементы, или если указанный набор является нулем.
    См. Также:
    contains(Object)
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Добавляют все элементы в указанном наборе к этому набору (дополнительная работа). Поведение этой работы неопределено, если указанный набор изменяется, в то время как работа происходит. (Это подразумевает, что поведение этого вызова неопределено, если указанный набор является этим набором, и этот набор непуст.)
    Эта реализация выполняет итерации по указанному набору, и добавляет каждый объект, возвращенный iterator к этому набору, поочередно.
    Отметьте, что эта реализация бросит UnsupportedOperationException, если add не будет переопределен (принятие, что указанный набор непуст).
    
    Определенный:
    
    addAll в интерфейсе Collection<E>
    
    Параметры:
    c - набор, содержащий элементы, которые будут добавлены к этому набору
    
    Возвраты:
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    UnsupportedOperationException - если работа addAll не поддерживается этим набором
    
    ClassCastException - если класс элемента указанного набора препятствует тому, чтобы это было добавлено к этому набору
    
    NullPointerException - если указанный набор содержит нулевой элемент, и этот набор не разрешает нулевые элементы, или если указанный набор является нулем
    
    IllegalArgumentException - если некоторое свойство элемента указанного набора препятствует тому, чтобы это было добавлено к этому набору
    
    IllegalStateException - если не все элементы могут быть добавлены в это время из-за ограничений вставки
    См. Также:
    add(Object)
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Удаляет все элементы этого набора, которые также содержатся в указанном наборе (дополнительная работа). После этого вызова возвраты этот набор не будет содержать элементов вместе с указанным набором.
    Эта реализация выполняет итерации по этому набору, проверяя каждый элемент, возвращенный iterator поочередно, чтобы видеть, содержится ли это в указанном наборе. Если это столь содержится, это удаляется из этого набора с методом remove iterator.
    Отметьте, что эта реализация бросит UnsupportedOperationException, если iterator, возвращенный методом iterator, не реализует метод remove, и этот набор содержит один или более элементов вместе с указанным набором.
    
    Определенный:
    
    removeAll в интерфейсе Collection<E>
    
    Параметры:
    c - набор, содержащий элементы, которые будут удалены из этого набора
    
    Возвраты:
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    UnsupportedOperationException - если метод removeAll не поддерживается этим набором
    
    ClassCastException - если типы одного или более элементов в этом наборе являются несовместимыми с указанным (дополнительным) набором
    
    NullPointerException - если этот набор содержит один или более нулевых элементов, и указанный набор не поддерживает нулевые (дополнительные) элементы, или если указанный набор является нулем
    См. Также:
    remove(Object), contains(Object)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Сохраняет только элементы в этом наборе, которые содержатся в указанном наборе (дополнительная работа). Другими словами, удаляет из этого набора все его элементы, которые не содержатся в указанном наборе.
    Эта реализация выполняет итерации по этому набору, проверяя каждый элемент, возвращенный iterator поочередно, чтобы видеть, содержится ли это в указанном наборе. Если это не столь содержится, это удаляется из этого набора с методом remove iterator.
    Отметьте, что эта реализация бросит UnsupportedOperationException, если iterator, возвращенный методом iterator, не реализует метод remove, и этот набор содержит один или более элементов, не существующих в указанном наборе.
    
    Определенный:
    
    retainAll в интерфейсе Collection<E>
    
    Параметры:
    c - набор, содержащий элементы, которые будут сохранены в этом наборе
    
    Возвраты:
    true, если этот набор изменился в результате вызова
    
    Броски:
    
    UnsupportedOperationException - если работа retainAll не поддерживается этим набором
    
    ClassCastException - если типы одного или более элементов в этом наборе являются несовместимыми с указанным (дополнительным) набором
    
    NullPointerException - если этот набор содержит один или более нулевых элементов, и указанный набор не разрешает нулевые (дополнительные) элементы, или если указанный набор является нулем
    См. Также:
    remove(Object), contains(Object)
  - очистить
```
public void clear()
```
    Удаляет все элементы от этого набора (дополнительная работа). Набор будет пуст после этого метода возвраты.
    Эта реализация выполняет итерации по этому набору, удаляя каждый элемент, используя работу Iterator.remove. Большинство реализаций будет, вероятно, хотеть переопределять этот метод для эффективности.
    Отметьте, что эта реализация бросит UnsupportedOperationException, если iterator, возвращенный методом iterator этого набора, не реализует метод remove, и этот набор непуст.
    
    Определенный:
    
    clear в интерфейсе Collection<E>
    
    Броски:
    
    UnsupportedOperationException - если работа clear не поддерживается этим набором
  - toString
```
public String toString()
```
    Возвращает строковое представление этого набора. Строковое представление состоит из списка элементов набора в порядке, они возвращаются его iterator, включенным в квадратные скобки ("[]"). Смежные элементы разделяются символами ", " (запятая и пространство). Элементы преобразовываются в строки как String.valueOf(Object).
    
    Переопределения:
    
    toString в классе Object
    
    Возвраты:
    строковое представление этого набора

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

Класс AbstractCollection <E>

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

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

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

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

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

AbstractCollection

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

iterator

размер

isEmpty

содержит

toArray

toArray

добавить

удалить

containsAll

addAll

removeAll

retainAll

очистить

toString