Список интерфейсов<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>

Возвращает:

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

См. также:

• Arrays.asList(Object[])

<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 (как указано в Collection.add(E))

Выбрасывает:

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 addAll(int index, Collection<? extends E> c)

Параметры:

index - индекс, в котором следует вставить первый элемент из указанного набора

c - набор, содержащий элементы, которые нужно добавить в этот список

Возвращает:

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

Исключения:

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

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

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

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

IndexOutOfBoundsException - если индекс находится вне допустимого диапазона (index < 0 || index > size())

boolean removeAll(Collection<?> c)

Определено в:

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

Параметры:

c - набор, содержащий элементы, которые нужно удалить из этого списка

Возвращает:

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

Исключения:

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

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

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

См. также:

• remove(Object)
• contains(Object)

boolean retainAll(Collection<?> c)

Определено в:

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

Параметры:

c - набор, содержащий элементы, которые нужно сохранить в этом списке

Возвращает:

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

Исключения:

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

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

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

См. также:

• remove(Object)
• contains(Object)

default void replaceAll(UnaryOperator<E> operator)

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

Стандартная реализация эквивалентна для этого list:

     final ListIterator<E> li = list.listIterator();
     while (li.hasNext()) {
         li.set(operator.apply(li.next()));
     }
 

Если итератор списка не поддерживает операцию set, то при замене первого элемента будет выброшено исключение UnsupportedOperationException.

Параметры:

operator - оператор, применяемый к каждому элементу

Исключения:

UnsupportedOperationException - если операция replaceAll не поддерживается этим списком

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

С:

1.8

default void sort(Comparator<? super E> c)

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

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

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

Эта реализация — стабильная адаптивная итеративная сортировка слиянием, которая требует намного меньше, чем n lg(n), сравнений, когда входной массив частично отсортирован, при этом обеспечивает производительность традиционной сортировки слиянием при случайном порядке входного массива. Если входной массив почти отсортирован, реализация требует примерно n сравнений. Требования к временной памяти варьируются от малой константы для почти отсортированных входных массивов до n/2 ссылок на объекты для случайных входных массивов.

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

Реализация адаптирована из сортировки списков Tim Peters для Python ( TimSort). Она использует техники из "Optimistic Sorting and Information Theoretic Complexity" Питера МакИлроя, в Proceedings of the Fourth Annual ACM-SIAM Symposium on Discrete Algorithms, страницы 467-474, январь 1993 года.

Параметры:

c - Comparator, используемый для сравнения элементов списка. Значение null указывает на использование естественного порядка элементов

Исключения:

ClassCastException - если список содержит элементы, которые не взаимно сравнимы с помощью указанного компаратора

UnsupportedOperationException - если операция sort не поддерживается этим списком

IllegalArgumentException - (необязательно) если компаратор нарушает контракт Comparator

С:

1.8

void clear()

Определено в:

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

Исключения:

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

boolean equals(Object o)

Определено в:

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

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

equals в классе Object

Параметры:

o - объект, который нужно сравнить на равенство с этим списком

Возвращает:

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

См. также:

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

int hashCode()

     int hashCode = 1;
     for (E e : list)
         hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());
 

Указано в:

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

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

hashCode в классе Object

Возвращает:

значение хэш-кода для этого списка

См. также:

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

E get(int index)

Параметры:

index - индекс возвращаемого элемента

Возвращает:

элемент по указанному индексу в этом списке

Исключения:

IndexOutOfBoundsException - если индекс вне допустимого диапазона (index < 0 || index >= size())

E set(int index, E element)

Параметры:

index - индекс заменяемого элемента

element - элемент, который будет сохранён по указанному индексу

Возвращает:

элемент, который ранее находился по указанному индексу

Исключения:

UnsupportedOperationException - если операция set не поддерживается этим списком

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

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

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

IndexOutOfBoundsException - если индекс вне допустимого диапазона (index < 0 || index >= size())

void add(int index, E element)

Параметры:

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

element - вставляемый элемент

Исключения:

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

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

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

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

IndexOutOfBoundsException - если индекс вне допустимого диапазона (index < 0 || index > size())

E remove(int index)

Параметры:

index - индекс удаляемого элемента

Возвращает:

элемент, который ранее находился по указанному индексу

Исключения:

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

IndexOutOfBoundsException - если индекс вне допустимого диапазона (index < 0 || index >= size())

int indexOf(Object o)

Параметры:

o - искомый элемент

Возвращает:

индекс первого вхождения указанного элемента в этот список, или -1, если этот список не содержит элемент

Исключения:

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

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

int lastIndexOf(Object o)

Параметры:

o - искомый элемент

Возвращает:

индекс последнего вхождения указанного элемента в этот список, или -1, если этот список не содержит элемент

Исключения:

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

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

ListIterator<E> listIterator()

Возвращает:

итератор списка по элементам в этом списке (в правильном порядке)

ListIterator<E> listIterator(int index)

Параметры:

index - индекс первого элемента, который будет возвращён итератором списка (в результате вызова next)

Возвращает:

итератор списка по элементам в этом списке (в правильном порядке), начиная с указанной позиции в списке

Исключения:

IndexOutOfBoundsException - если индекс вне допустимого диапазона (index < 0 || index > size())

List<E> subList(int fromIndex, int toIndex)

      list.subList(from, to).clear();
 

Параметры:

fromIndex - нижняя граница (включительно) подсписка

toIndex - верхняя граница (исключительно) подсписка

Возвращает:

представление указанного диапазона в этом списке

Исключения:

IndexOutOfBoundsException - для недопустимого значения индекса конечной точки (fromIndex < 0 || toIndex > size || fromIndex > toIndex)

default Spliterator<E> spliterator()

Указано:

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

Указано:

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

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

По умолчанию реализация создаёт отложенно-связанный спитерратор следующим образом:

• Если список является экземпляром RandomAccess, то по умолчанию реализация создаёт спитерратор, который проходит по элементам, вызывая метод get(int). Если такое обращение приводит или привело бы к IndexOutOfBoundsException, то спитерратор будет немедленно завершён и сгенерирует исключение ConcurrentModificationException. Если список также является экземпляром AbstractList, то спитерратор будет использовать поле списка modCount для обеспечения дополнительного поведения немедленного завершения.
• В противном случае по умолчанию реализация создаёт спитерратор из Iterator списка. Спитерратор наследует немедленное завершение итератора списка.

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

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

Возвращает:

Spliterator над элементами в этом списке

С:

1.8

default void addFirst(E e)

Указано:

addFirst в интерфейсе SequencedCollection<E>

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

Реализация в этом интерфейсе вызывает add(0, e).

Параметры:

e - добавляемый элемент

Исключение:

NullPointerException - если указанный элемент null, и эта коллекция не допускает null элементов

UnsupportedOperationException - если данная реализация коллекции не поддерживает данную операцию

С:

21

default void addLast(E e)

Указано:

addLast в интерфейсе SequencedCollection<E>

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

Реализация в этом интерфейсе вызывает add(e).

Параметры:

e - добавляемый элемент.

Исключение:

NullPointerException - если указанный элемент null, и эта коллекция не допускает null элементов

UnsupportedOperationException - если данная реализация коллекции не поддерживает данную операцию

С:

21

default E getFirst()

Указано:

getFirst в интерфейсе SequencedCollection<E>

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

Если этот список не пуст, реализация в этом интерфейсе возвращает результат вызова get(0). В противном случае он генерирует исключение NoSuchElementException.

Возвращает:

полученный элемент

Исключение:

NoSuchElementException - если эта коллекция пуста

С:

21

default E getLast()

Указано:

getLast в интерфейсе SequencedCollection<E>

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

Если этот список не пуст, реализация в этом интерфейсе возвращает результат вызова get(size() - 1). В противном случае он генерирует исключение NoSuchElementException.

Возвращает:

полученный элемент

Исключение:

NoSuchElementException - если эта коллекция пуста

С:

21

default E removeFirst()

Указано:

removeFirst в интерфейсе SequencedCollection<E>

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

Если этот список не пуст, реализация в этом интерфейсе возвращает результат вызова remove(0). В противном случае он генерирует исключение NoSuchElementException.

Возвращает:

удаленный элемент

Исключение:

NoSuchElementException - если эта коллекция пуста

UnsupportedOperationException - если данная реализация коллекции не поддерживает данную операцию

С:

21

default E removeLast()

Указано:

removeLast в интерфейсе SequencedCollection<E>

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

Если этот список не пуст, реализация в этом интерфейсе возвращает результат вызова remove(size() - 1). В противном случае он генерирует исключение NoSuchElementException.

Возвращает:

удаленный элемент

Исключение:

NoSuchElementException - если эта коллекция пуста

UnsupportedOperationException - если данная реализация коллекции не поддерживает данную операцию

С:

21

default List<E> reversed()

Указано:

reversed в интерфейсе SequencedCollection<E>

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

Реализация в этом интерфейсе возвращает представление списка в обратном порядке. Метод reversed() представления возвращает ссылку на этот список. Другие операции над представлением реализуются через вызовы публичных методов этого списка. Точное соотношение между вызовами представления и вызовами этого списка не определено. Однако операции, чувствительные к порядку, обычно ведут себя так, как будто они делегируют соответствующему методу с противоположной ориентацией. Например, вызов getFirst на представлении может привести к вызову getLast на этом списке.

Возвращает:

представление этой коллекции в обратном порядке, как List

С:

21

static <E> List<E> of()

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

E - тип элемента List

Возвращает:

пустой List

С:

9

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

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

E - тип элемента List

Параметры:

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

Возвращает:

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

Исключение:

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

С:

9

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

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

E - тип элемента List

Параметры:

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

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

Возвращает:

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

Исключение:

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

С:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

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

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

Type Parameters:

E - тип элемента List

Parameters:

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

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

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

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

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

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

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

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

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

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

Returns:

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

Throws:

NullPointerException - если элемент является null

Since:

9

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

API Note:

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

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

Это вызовет метод List.of(E) вместо этого.

Type Parameters:

E - тип элемента List

Parameters:

elements - элементы, которые должны содержаться в списке

Returns:

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

Throws:

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

Since:

9

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

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

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

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

E - тип элементов List

Параметры:

coll - набор, из которого берутся элементы, не должен быть null

Возвращает:

список, содержащий элементы заданного набора

Исключения:

NullPointerException - если coll null или содержит какие-либо нулевые элементы

С момента:

10