java.util

Интерфейсный Набор <E>

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

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

Все Суперинтерфейсы:

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

Все Известные Подынтерфейсы:

NavigableSet <E>, SortedSet <E>

Все Известные Классы с реализацией:

AbstractSet, ConcurrentSkipListSet, CopyOnWriteArraySet, EnumSet, HashSet, JobStateReasons, LinkedHashSet, TreeSet

public interface Set<E>
extends Collection<E>

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

Интерфейс Set помещает дополнительные соглашения, вне наследованных от интерфейса Collection, по контрактам всех конструкторов и по контрактам add, методов equals И hashCode. Объявления для других наследованных методов также включаются здесь для удобства. (Спецификации, сопровождающие эти объявления, были адаптированы в соответствии с интерфейсом Set, но они не содержат дополнительных соглашений.)

Дополнительное соглашение на конструкторах, не удивительно, что все конструкторы должны создать набор, который не содержит двойных элементов (как определено выше).

Отметьте: Большая забота должна быть осуществлена, если изменчивые объекты используются в качестве элементов набора. Поведение набора не определяется, если значение объекта изменяется способом, который влияет на сравнения equals, в то время как объект является элементом в наборе. Особый случай этого запрета - то, что не допустимо для набора содержать себя как элемент.

У некоторых реализаций набора есть ограничения на элементы, которые они могут содержать. Например, некоторые реализации запрещают нулевые элементы, и у некоторых есть ограничения на типы их элементов. Попытка добавить неподходящий элемент выдает исключение непроверенное, обычно NullPointerException или ClassCastException. Попытка запросить присутствие неподходящего элемента может выдать исключение, или это может просто возвратить false; некоторые реализации покажут прежнее поведение, и некоторые покажут последнего. Более широко попытка работы на неподходящем элементе, завершение которого не привело бы к вставке неподходящего элемента в набор, может выдать исключение, или это может успешно выполниться в опции реализации. Такие исключения отмечаются как "дополнительные" в спецификации для этого интерфейса.

Этот интерфейс является элементом Платформы Наборов Java.

С тех пор:

1.2

См. Также:

Collection, List, SortedSet, HashSet, TreeSet, AbstractSet, Collections.singleton(java.lang.Object), Collections.EMPTY_SET

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

Методы

Модификатор и Тип	Метод и Описание
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) Сравнивает указанный объект с этим набором для равенства.
int	hashCode() Возвращает значение хэш-кода для этого набора.
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) Возвращает массив, содержащий все элементы в этом наборе; тип времени выполнения возвращенного массива является типом указанного массива.

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

размер

int size()

Возвращает число элементов в этом наборе (его количество элементов). Если этот набор содержит больше чем элементы Integer.MAX_VALUE, Integer.MAX_VALUE возвратов.

Определенный:

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

Возвраты:

число элементов в этом наборе (его количество элементов)

isEmpty

boolean isEmpty()

true возвратов, если этот набор не содержит элементов.

Определенный:

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

Возвраты:

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

содержит

boolean contains(Object o)

true возвратов, если этот набор содержит указанный элемент. Более формально, возвраты true, если и только если этот набор содержит элемент e так, что (o==null ? e==null : o.equals(e)).

Определенный:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

iterator

Iterator<E> iterator()

Возвращает iterator по элементам в этом наборе. Элементы возвращаются без определенного порядка (если этот набор не является экземпляром некоторого класса, который обеспечивает гарантию).

Определенный:

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

Определенный:

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

Возвраты:

iterator по элементам в этом наборе

toArray

Object[] toArray()

Возвращает массив, содержащий все элементы в этом наборе. Если этот набор делает какие-либо гарантии относительно того, какой порядок его элементы возвращаются его iterator, этот метод должен возвратить элементы в том же самом порядке.

Возвращенный массив будет "безопасен" в этом, никакие ссылки на него не сохраняются этим набором. (Другими словами этот метод должен выделить новый массив, даже если этот набор поддерживается массивом). Вызывающая сторона таким образом свободна изменить возвращенный массив.

Этот метод действует как мост между основанными на массиве и основанными на наборе API.

Определенный:

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

Возвраты:

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

toArray

<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>

Параметры:

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

Возвраты:

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

Броски:

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

NullPointerException - если указанный массив является нулем

добавить

boolean add(E e)

Добавляет указанный элемент к этому набору, если это уже не присутствует (дополнительная работа). Более формально добавляет указанный элемент e к этому набору, если набор не содержит элемента e2 так, что (e==null ? e2==null : e.equals(e2)). Если этот набор уже содержит элемент, листы вызова неизменный набор и возвращает false. В комбинации с ограничением на конструкторов это гарантирует, что наборы никогда не содержат двойные элементы.

Соглашение выше не подразумевает, что наборы должны принять все элементы; наборы могут отказаться добавить любой определенный элемент, включая null, и выдать исключение, как описано в спецификации для Collection.add. Отдельные реализации набора должны ясно задокументировать любые ограничения на элементы, которые они могут содержать.

Определенный:

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

Параметры:

e - элемент, который будет добавлен к этому набору

Возвраты:

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

Броски:

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

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

NullPointerException - если указанный элемент является нулем, и этот набор не разрешает нулевые элементы

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

удалить

boolean remove(Object o)

Удаляет указанный элемент из этого набора, если это присутствует (дополнительная работа). Более формально, удаляет элемент e так, что (o==null ? e==null : o.equals(e)), если этот набор содержит такой элемент. Возвраты true, если этот набор, содержавший элемент (или эквивалентно, если этот набор, измененный в результате вызова). (Этот набор не будет содержать элемент, как только вызов возвращается.)

Определенный:

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

Параметры:

o - объект, который будет удален из этого набора, если существующий

Возвраты:

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

Броски:

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

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

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

containsAll

boolean containsAll(Collection<?> c)

true возвратов, если этот набор содержит все элементы указанного набора. Если указанный набор является также набором, этот метод возвращает true, если это - подмножество этого набора.

Определенный:

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

Параметры:

c - набор, который будет проверен на включение в этом наборе

Возвраты:

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

Броски:

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

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

См. Также:

contains(Object)

addAll

boolean addAll(Collection<? extends E> c)

Добавляют все элементы в указанном наборе к этому набору, если они уже не присутствуют (дополнительная работа). Если указанный набор является также набором, работа addAll эффективно изменяет этот набор так, чтобы его значение было объединением двух наборов. Поведение этой работы неопределено, если указанный набор изменяется, в то время как работа происходит.

Определенный:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

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

См. Также:

add(Object)

retainAll

boolean retainAll(Collection<?> c)

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

Определенный:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

См. Также:

remove(Object)

removeAll

boolean removeAll(Collection<?> c)

Удаляет из этого набора все его элементы, которые содержатся в указанном наборе (дополнительная работа). Если указанный набор является также набором, эта работа эффективно изменяет этот набор так, чтобы его значение было асимметричной разностью множеств двух наборов.

Определенный:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

См. Также:

remove(Object), contains(Object)

очистить

void clear()

Удаляет все элементы от этого набора (дополнительная работа). Набор будет пуст после этого вызова возвраты.

Определенный:

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

Броски:

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

равняется

boolean equals(Object o)

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

Определенный:

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

Переопределения:

equals в классе Object

Параметры:

o - объект, который будет сравнен для равенства с этим набором

Возвраты:

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

См. Также:

Object.hashCode(), HashMap

хэш-код

int hashCode()

Возвращает значение хэш-кода для этого набора. Хэш-код набора определяется, чтобы быть суммой хэш-кодов элементов в наборе, где хэш-код элемента null определяется, чтобы быть нулем. Это гарантирует, что s1.equals(s2) подразумевает что s1.hashCode()==s2.hashCode() для любых двух наборов s1 и s2, как требуется согласно общему контракту Object.hashCode().

Определенный:

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

Переопределения:

hashCode в классе Object

Возвраты:

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

См. Также:

Object.equals(Object), equals(Object)