java.util
인터페이스 Set<E>

모든 슈퍼 인터페이스:

Collection <E>, Iterable <E>

알려진 서브 인터페이스 목록 :

SortedSet <E>

알려진 구현 클래스 목록:

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

public interface Set<E>
extends Collection <E>

중복 요소가 없는 컬렉션입니다. 즉, 세트는 e1.equals(e2)인 e1와 e2 요소 페어는 가지지 않고, null 요소를 최대 1개 밖에 가지지 않습니다. 그 이름이 가리키도록, 이 인터페이스는 수학으로 말하는 집합의 추상화를 모델화합니다.

Set 인터페이스는 Collection 인터페이스로부터 상속한 규정 뿐만이 아니라, 모든 생성자 규약 및 add, equals, hashCode 각 메서드의 규약에 추가의 규정을 적용합니다. 편의상, 다른 상속 메서드의 선언도 여기에 포함됩니다. 이러한 선언에 부수 하는 사양은 Set 인터페이스에 맞추어 조정필 보고입니다만, 추가 규정은 포함되어 있지 않습니다.

생성자에 대한 추가 규정으로서 모든 생성자는 중복 요소가 없는 세트를 작성하지 않으면 안됩니다 (상기를 참조).

주: 가변 객체가 세트 요소로서 사용되는 경우는 세심의 주의가 필요합니다. 객체가 세트내의 요소인 동안에 equals 비교에 영향을 주는 방식에서 그 값이 변경되었을 경우, 세트의 동작은 보증되지 않습니다. 이 금지 사항의 특례에의해 세트가 그 자체를 요소로서 가지는 것은 허가되지 않습니다.

세트의 구현에는 포함할 수 있는 요소에 제한이 있는 것도 있습니다. 예를 들어 null 요소를 금지하는 구현이나, null 요소의 형태에 제한이 있는 구현도 있습니다. 부적당한 요소를 추가하려고 하면, 보통 NullPointerException 또는 ClassCastException와 같은 체크되지 않는 예외가 발생 됩니다. 부적당한 요소를 조회하려고 하면, 예외가 발생되는 경우나, 다만 false를 돌려주는 경우도 있습니다. 전의 동작을 금지하는 구현도 있으면, 후의 동작을 금지하는 구현도 있습니다. 좀 더 일반적으로 말하면, 세트에의 삽입이 되지 않는 부적당한 요소를 처리하려고 하면, 예외가 발생되는 경우나, 처리가 유효하게 되는 경우가 있습니다. 이 인터페이스에 관한 그러한 예외는 「임의」의 사양으로서 마크 됩니다.

이 인터페이스는 Java Collections Framework 멤버입니다.

도입된 버전 :

1.2

관련 항목:

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

메서드 개요

boolean	add (E o) 지정된 요소가 세트내에 없었던 경우, 세트에 추가합니다 (임의의 오퍼레이션).
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 () 세트가 요소를 1개 나 보관 유지하고 있지 않는 경우에 true를 리턴합니다.
Iterator <E >	iterator () 세트내의 요소에 대한 반복자를 리턴합니다.
boolean	remove (Object o) 지정된 요소가 세트내에 있었을 경우, 세트로부터 삭제합니다 (임의의 오퍼레이션).
boolean	removeAll (Collection <? > c) 세트로부터, 지정된 컬렉션내에 있는 요소를 모두 삭제합니다 (임의의 오퍼레이션).
boolean	retainAll (Collection <? > c) 세트내의 요소 가운데, 지정된 컬렉션내에 있는 요소만을 보관 유지합니다 (임의의 오퍼레이션).
int	size () 세트내의 요소수 (카디나리티)를 리턴합니다.
Object []	toArray () 세트내의 모든 요소가 포함되고 있는 배열을 리턴합니다.
<T> T[]	toArray (T[] a) 세트내의 모두 요소를 포함하고 있는 배열을 리턴합니다.

메서드의 상세

size

int size()

세트내의 요소수 (카디나리티)를 리턴합니다. 이 세트에 Integer.MAX_VALUE 보다 많은 요소가 있는 경우는 Integer.MAX_VALUE를 리턴합니다.

정의:

인터페이스 Collection <E > 내의 size

반환값:

세트내의 요소수 (그 카디나리티)

isEmpty

boolean isEmpty()

세트가 요소를 1개 나 보관 유지하고 있지 않는 경우에 true를 리턴합니다.

정의:

인터페이스 Collection <E > 내의 isEmpty

반환값:

세트가 요소를 1개 나 보관 유지하고 있지 않는 경우는 true

contains

boolean contains(Object  o)

지정된 요소가 세트내에 있는 경우에 true를 리턴합니다. 즉, 세트내에 (o==null ? e==null : o.equals(e))에 해당하는 요소 e가 있는 경우에만 true를 리턴합니다.

정의:

인터페이스 Collection <E > 내의 contains

파라미터:

o - 세트에 있을지 어떨지를 조사하는 요소

반환값:

세트가 지정된 요소를 보관 유지하고 있는 경우는 true

예외:

ClassCastException - 지정된 요소의 형태가 이 세트와 호환이 아닌 경우 (임의의 옵션)

NullPointerException - 지정된 요소가 null 로 이 세트가 null 요소를 지원 하지 않는 경우 (임의의 옵션)

iterator

Iterator <E > iterator()

세트내의 요소에 대한 반복자를 리턴합니다. 세트가 순서를 보증하는 특정 클래스의 인스턴스가 아닌 한, 요소는 특정의 순서에서는 돌려주고지지 않습니다.

정의:

인터페이스 Collection <E > 내의 iterator

정의:

인터페이스 Iterable <E > 내의 iterator

반환값:

세트의 요소의 반복자

toArray

Object [] toArray()

세트내의 모든 요소가 포함되고 있는 배열을 리턴합니다. Collection.toArray() 메서드의 일반 규약에 따릅니다.

정의:

인터페이스 Collection <E > 내의 toArray

반환값:

세트내의 모든 요소를 보관 유지하고 있는 배열

toArray

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

세트내의 모두 요소를 포함하고 있는 배열을 리턴합니다. 리턴된 배열의 실행시의 형태는 지정된 배열의 형태가 됩니다. Collection.toArray(Object[]) 메서드의 일반 규약에 따릅니다.

정의:

인터페이스 Collection <E > 내의 toArray

파라미터:

a - 세트의 요소의 포함처의 배열. 배열의 사이즈가 충분하지 않은 경우는 같은 실행시의 형태로 새로운 배열이 포함용으로서 할당할 수 있다

반환값:

세트의 요소가 포함되고 있는 배열

예외:

ArrayStoreException - a 실행시의 형태가 세트내의 각 요소의 실행시의 형태의 슈퍼타입이 아닌 경우

NullPointerException - 지정된 배열이 null 인 경우

add

boolean add(E  o)

지정된 요소가 세트내에 없었던 경우, 세트에 추가합니다 (임의의 오퍼레이션). 즉, 세트내에 (o==null ? e==null : o.equals(e))에 해당하는 요소 e가 없었던 경우는 지정된 요소 o를 세트에 추가합니다. 세트내에 이미 지정된 요소가 있는 경우, 호출은 세트를 변경하지 않고 false를 리턴합니다. 이 때문에 생성자에 대한 제약과의 편성에의해 세트가 중복 요소를 가지지 않는 것을 보증합니다.

이 규정은 세트가 모든 요소를 받아들이지 않으면 안 되는 것을의미하는 것은 아닙니다. 즉, 세트에서는 null을 포함한 임의의 요소의 추가를 거부하거나 예외를 Throw 하는 것을 임의로 지정할 수 있습니다 (Collection.add 사양을 참조). 세트의 각 구현에서는 세트가 가질 수 있는 요소에 대한 제약을 명기하도록의해 주세요.

정의:

인터페이스 Collection <E > 내의 add

파라미터:

o - 세트에 추가되는 요소

반환값:

세트가 지정된 요소를 보관 유지하고 있지 않았던 경우는 true

예외:

UnsupportedOperationException - 세트가 add 메서드를 지원 하고 있지 않는 경우

ClassCastException - 지정된 요소의 클래스를 위해서 세트에 요소를 추가할 수 없는 경우

NullPointerException - 지정된 요소가 null 로 이 세트가 null 요소를 지원 하지 않는 경우

IllegalArgumentException - 이 요소의 특정의 특성을 위해서 세트에 요소를 추가할 수 없는 경우

remove

boolean remove(Object  o)

지정된 요소가 세트내에 있었을 경우, 세트로부터 삭제합니다 (임의의 오퍼레이션). 즉, 세트내에 (o==null ? e==null : o.equals(e))에 해당하는 요소 e가 있었을 경우는 그것을 삭제합니다. 지정된 요소가 세트내에 있었을 경우 (세트가 호출의 결과로서 변경되었을 경우)는 true를 리턴합니다. 호출이 복귀한 뒤는 세트는 지정된 요소를 가지고 있지 않습니다.

정의:

인터페이스 Collection <E > 내의 remove

파라미터:

o - 세트에 있으면 삭제되는 객체

반환값:

지정된 요소가 세트내에 있었을 경우는 true

예외:

ClassCastException - 지정된 요소의 형태가 이 세트와 호환이 아닌 경우 (임의의 옵션)

NullPointerException - 지정된 요소가 null 로 이 세트가 null 요소를 지원 하지 않는 경우 (임의의 옵션)

UnsupportedOperationException - 세트가 remove 메서드를 지원 하고 있지 않는 경우

containsAll

boolean containsAll(Collection <? > c)

지정된 컬렉션의 모든 요소가 세트내에 있는 경우에 true를 리턴합니다. 지정된 컬렉션도 세트인 경우, 지정된 세트가 이 세트의 「부분집합」이면, 이 메서드는 true를 리턴합니다.

정의:

인터페이스 Collection <E > 내의 containsAll

파라미터:

c - 이 세트에 있을지 어떨지를 조사하는 컬렉션

반환값:

지정된 컬렉션의 모든 요소가 세트에 포함되어 있는 경우는 true

예외:

ClassCastException - 지정된 컬렉션의 1개 또는 복수의 요소의 형태가 이 세트와 호환이 아닌 경우 (임의의 옵션)

NullPointerException - 지정된 컬렉션이 1개 또는 복수의 null 요소를 포함해, 이 세트가 null 요소를 지원 하지 않는 경우 (임의의 옵션)

NullPointerException - 지정된 컬렉션이 null 인 경우

관련 항목:

contains(Object)

addAll

boolean addAll(Collection <?  extends E > c)

지정된 컬렉션의 모든 요소에 대해, 그 요소가 이 세트내에 없는 경우, 세트에 추가합니다 (임의의 오퍼레이션). 지정된 컬렉션도 세트인 경우, addAll 오퍼레이션은 효율적으로 세트를 변경해, 그 값이 2개 세트의 「화집합」이 되도록 합니다. 지정된 컬렉션이 이 오퍼레이션의 처리중으로 변경되었을 경우, 그 오퍼레이션의 동작은 보증되지 않습니다.

정의:

인터페이스 Collection <E > 내의 addAll

파라미터:

c - 요소가 세트에 추가되는 컬렉션

반환값:

이 호출의 결과, 이 세트가 변경되었을 경우는 true

예외:

UnsupportedOperationException - 세트가 addAll 메서드를 지원 하고 있지 않는 경우

ClassCastException - 지정된 컬렉션의 요소의 클래스가 원인으로 그 요소를 세트에 추가할 수 없는 경우

NullPointerException - 지정된 컬렉션내에 1개 또는 복수의 null 요소가 포함되지 않고, 이 세트가 null 요소를 지원 하지 않는 경우. 또는 지정된 컬렉션이 null인 경우

IllegalArgumentException - 지정된 컬렉션의 요소의 특성이 원인으로 그 요소를 세트에 추가할 수 없는 경우

관련 항목:

add(Object)

retainAll

boolean retainAll(Collection <? > c)

세트내의 요소 가운데, 지정된 컬렉션내에 있는 요소만을 보관 유지합니다 (임의의 오퍼레이션). 즉, 세트로부터, 지정된 컬렉션내에 없는 요소를 모두 삭제합니다. 지정된 컬렉션도 세트인 경우, 이 오퍼레이션의 결과, 세트의 값은 2개 세트의 「공통 부분」이 됩니다.

정의:

인터페이스 Collection <E > 내의 retainAll

파라미터:

c - 세트가 보관 유지하는 요소를 정의하는 컬렉션

반환값:

이 호출의 결과, 이 컬렉션이 변경되었을 경우는 true

예외:

UnsupportedOperationException - 컬렉션이 retainAll 메서드를 지원 하고 있지 않는 경우

ClassCastException - 이 컬렉션의 1개 또는 복수의 요소의 형태가 지정된 세트와 호환이 아닌 경우 (임의의 옵션)

NullPointerException - 이 세트가 null 요소를 포함해, 지정된 컬렉션이 null 요소를 지원 하지 않는 경우 (임의의 옵션)

NullPointerException - 지정된 컬렉션이 null 인 경우

관련 항목:

remove(Object)

removeAll

boolean removeAll(Collection <? > c)

세트로부터, 지정된 컬렉션내에 있는 요소를 모두 삭제합니다 (임의의 오퍼레이션). 지정된 컬렉션도 세트인 경우, 이 오퍼레이션은 값이 2개 세트의 「비대칭 집합 차분」이 되도록 세트를 효율적으로 변경합니다.

정의:

인터페이스 Collection <E > 내의 removeAll

파라미터:

c - 어느 요소가 세트로부터 삭제되는지를 정의하는 컬렉션

반환값:

이 호출의 결과, 이 세트가 변경되었을 경우는 true

예외:

UnsupportedOperationException - 이 컬렉션이 removeAll 메서드를 지원 하지 않는 경우

ClassCastException - 이 컬렉션의 1개 또는 복수의 요소의 형태가 지정된 세트와 호환이 아닌 경우 (임의의 옵션)

NullPointerException - 이 세트가 null 요소를 포함해, 지정된 컬렉션이 null 요소를 지원 하지 않는 경우 (임의의 옵션)

NullPointerException - 지정된 컬렉션이 null 인 경우

관련 항목:

remove(Object)

clear

void clear()

세트로부터 모든 요소를 삭제합니다 (임의의 오퍼레이션). 이 호출이 예외를 Throw 하지 않는 한, 세트는 이 호출이 복귀한 뒤에 비웁니다.

정의:

인터페이스 Collection <E > 내의 clear

예외:

UnsupportedOperationException - 세트가 clear 메서드를 지원 하고 있지 않는 경우

equals

boolean equals(Object  o)

지정된 객체가 세트와 같은가 어떤가를 비교합니다. 지정된 객체도 세트로 2개 세트가 같은 사이즈를 가져, 지정된 세트의 모든 멤버가 이 세트에 있는 경우, 또는 이 세트의 모든 멤버가 지정된 세트에 있는 경우는 true를 리턴합니다. 이것에 의해 equals 메서드가 세트 인터페이스의 다양한 구현으로 적절히 동작하는 것이 보증됩니다.

정의:

인터페이스 Collection <E > 내의 equals

오버라이드(override):

클래스 Object 내의 equals

파라미터:

o - 이 세트와 동일한지 어떤지가 비교되는 Object

반환값:

지정된 Object가 세트와 같은 경우는 true

관련 항목:

Object.hashCode(), Hashtable

hashCode

int hashCode()

세트의 해시 코드값을 리턴합니다. 세트의 해시 코드는 세트내의 각 요소의 해시 코드의 합계입니다. 다만, null 요소의 해시 코드는 제로가 됩니다. 이것에 의해 Object.hashCode 메서드의 일반 규약으로 요구되고 있도록, 임의의 2개 세트 s1와 s2로 s1.equals(s2)인 경우에 s1.hashCode() ==s2.hashCode()가 되는 것이 보증됩니다.

정의:

인터페이스 Collection <E > 내의 hashCode

오버라이드(override):

클래스 Object 내의 hashCode

반환값:

세트의 해시 코드값

관련 항목:

Object.hashCode(), Object.equals(Object), equals(Object)