java.util
인터페이스 Map<K, V>

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

ConcurrentMap <K, V>, SortedMap <K, V>

알려진 구현 클래스 목록:

AbstractMap, Attributes, AuthProvider, ConcurrentHashMap, EnumMap, HashMap, Hashtable, IdentityHashMap, LinkedHashMap, PrinterStateReasons, Properties, Provider, RenderingHints, TabularDataSupport, TreeMap, UIDefaults, WeakHashMap

public interface Map<K, V>

키를 값에 매핑 하는 객체입니다. 맵에는 동일한 키를 복수 등록할 수 없습니다. 각 키는 1개의 값밖에 매핑 할 수 없습니다.

이 인터페이스는 인터페이스라고 하는 것보다 오히려 완전하게 추상 클래스에서 만난 Dictionary 클래스에 대신하는 것입니다.

Map 인터페이스가 제공하는 3개의 코레크션뷰에의해 맵의 내용을 키세트, 값의 컬렉션, 혹은 키와 값의 매핑세트로서 표시할 수 있게 됩니다. 맵의 「순서」는 맵의 코레크션뷰의 반복자가 요소를 돌려줄 때의 순서로서 정의됩니다. TreeMap 클래스 등 일부의 맵의 구현에서는 순서에 대해 보증합니다만, HashMap 클래스등의 구현에서는 순서는 보증되지 않습니다.

주: 가변 객체를 맵 키로서 사용하는 경우는 세심의 주의가 필요합니다. 객체가 맵내의 키일 때, equals 비교에 영향을 주는 방법으로 객체의 값이 변경되었을 경우, 맵의 동작은 보증되지 않습니다. 이 금지 사항의 특수한 예로서 맵이 그것 자신을 키로서 가지지 못하는 것을 들 수 있습니다. 맵이 그것 자신을 값으로 해서 가지는 것은 허가됩니다만, 그 경우는 세심의 주의가 필요합니다. 이러한 맵의 경우, equals 메서드 및 hashCode 메서드의 결과는 보증되지 않습니다.

범용 맵의 구현 클래스는 모두, 다음의 2개의 표준적인 생성자를 제공하도록의해 주세요. 2개의 표준적인 생성자가란 void (인수 없음) 생성자과Map 형의 인수를 1개 취하는 생성자 입니다. 전자는 비어있는 맵을 작성해, 후자는 같은 키와 값의 매핑을 인수로서 가지는 새로운 맵을 작성합니다. 그 결과, 사용자는 후자의 생성자를 사용해 임의의 맵을 카피하는 것으로써, 필요한 클래스와 등가인 맵을 작성할 수 있습니다. 이것은 강제적인 것이 아닙니다만 (인터페이스가 생성자를 가질 수가 없기 때문에), JDK 에서의 범용 맵의 구현은 모두 이것에 따르고 있습니다.

이 맵이 오퍼레이션을 지원 하고 있지 않는 경우, 이 인터페이스 (처리되는 맵을 수정하는 메서드)에 포함되어 있는 「파괴적인」메서드는 UnsupportedOperationException을 Throw 하도록 지정되고 있습니다. 이 때, 호출이 맵에 영향을 미치지 않는 경우, 이러한 메서드는 UnsupportedOperationException을 Throw 하는 일이 있습니다만, 필수가 아닙니다. 예를 들어 매핑을 「거듭해 맞춘다」맵이 비어있는 경우에 변경 불가능한 맵으로 putAll(Map) 메서드를 호출하면, 예외를 Throw 하는 일이 있습니다만, 필수가 아닙니다.

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

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

Collections Framework 인터페이스내의 다수의 메서드는 equals 메서드와의 관련으로 정의됩니다. 예를 들어, contains(Object key) 메서드의 사양은 「이 맵 컬렉션에 (key==null ? k==null : key.equals(k))를 채우는 키 k가 포함되는 경우에게만, true를 돌려준다」라고 하는 것입니다. 이 사양은 「null 이외의 인수 key를 사용해 Map.containsKey를 호출하면, 키 k로 key.equals(k)가 불려 간다」라고 이해해야 하지는 않습니다. 최적화의 구현 방법은 자유롭기 때문에 2개의 키의 해시 코드를 최초로 비교하는 등 방법으로 equals 호출은 피할 수 있는 (Object.hashCode() 사양에서는 등가가 아닌 해시 코드를 보관 유지하는 2개의 객체는 등가가 아닌 것이 보증된다). 보통, 다양한 Collections Framework 인터페이스의 구현으로 구현자가 적절이라고 판단한다면, 기반이 되는 Object 메서드의 지정된 동작을 자유롭게 이용할 수 있습니다.

도입된 버전 :

1.2

관련 항목:

HashMap, TreeMap, Hashtable, SortedMap, Collection, Set

중첩(Nested) 클래스 개요

static interface

Map.Entry <K, V > 맵의 엔트리 (키와 값의 페어)입니다.

메서드 개요

void	clear () 맵으로부터 매핑을 모두 삭제합니다 (임의의 오퍼레이션).
boolean	containsKey (Object key) 지정된 키의 매핑이 맵에 포함되어 있는 경우에 true를 리턴합니다.
boolean	containsValue (Object value) 맵이, 지정된 값에 1개 이상의 키를 매핑 하고 있는 경우에 true를 리턴합니다.
Set <Map.Entry <K, V >>	entrySet () 맵에 포함되어 있는 매핑의 셋트뷰를 리턴합니다.
boolean	equals (Object o) 지정된 객체가 이 맵과 동일한지 어떤지를 비교합니다.
V	get (Object key) 맵이 지정된 키를 맵 하는 값을 리턴합니다.
int	hashCode () 맵의 해시 코드값을 리턴합니다.
boolean	isEmpty () 맵이 키와 값의 매핑을 보관 유지하지 않는 경우에 true를 리턴합니다.
Set <K >	keySet () 맵에 포함되고 있는 키의 셋트뷰를 리턴합니다.
V	put (K key, V value) 지정된 값과 지정된 키를 이 맵에 관련짓습니다 (임의의 오퍼레이션).
void	putAll (Map <? extends K, ? extends V > t) 지정된 맵의 모든 매핑을 이 맵에 카피합니다 (임의의 오퍼레이션).
V	remove (Object key) 이 키에 매핑이 있는 경우에 그 매핑을 맵으로부터 삭제합니다 (임의의 오퍼레이션).
int	size () 맵내의 키와 값의 매핑의 수를 리턴합니다.
Collection <V >	values () 맵에 포함되고 있는 값의 코레크션뷰를 리턴합니다.

메서드의 상세

size

int size()

맵내의 키와 값의 매핑의 수를 리턴합니다. 맵에 Integer.MAX_VALUE 보다 많은 요소가 있는 경우는 Integer.MAX_VALUE를 리턴합니다.

반환값:

맵내의 키와 값의 매핑의 수

isEmpty

boolean isEmpty()

맵이 키와 값의 매핑을 보관 유지하지 않는 경우에 true를 리턴합니다.

반환값:

맵이 키와 값의 매핑을 보관 유지하지 않는 경우는 true

containsKey

boolean containsKey(Object  key)

지정된 키의 매핑이 맵에 포함되어 있는 경우에 true를 리턴합니다. 즉, 맵에 (key==null ? k==null : key.equals(k))가 되는 키 k 매핑이 포함되어 있는 경우에만 true를 리턴합니다. 맵은 이러한 매핑을 1개 만 포함합니다.

파라미터:

key - 맵에 있을지 어떨지가 판정되는 키

반환값:

맵이 지정된 키의 매핑을 보관 유지하는 경우는 true

예외:

ClassCastException - 키가 맵에 적합하지 않는 형태의 경우 (임의의 옵션)

NullPointerException - 키가 null 때에 맵이 null 키를 허가하지 않는 경우 (임의의 옵션)

containsValue

boolean containsValue(Object  value)

맵이, 지정된 값에 1개 이상의 키를 매핑 하고 있는 경우에 true를 리턴합니다. 즉, 맵에 (value==null ? v==null : value.equals(v))가 되는 값 v에 의 매핑이 1개 이상 있는 경우에만 true를 리턴합니다. Map 인터페이스의 대부분의 구현으로 이 오퍼레이션에 걸리는 시간은 맵의 사이즈에 정비례 합니다.

파라미터:

value - 맵에 있을지 어떨지를 판정되는 값

반환값:

맵이 1개 또는 복수의 키와 지정된 값을 매핑 하고 있는 경우는 true

예외:

ClassCastException - 값이 맵에 적합하지 않는 형태의 경우 (임의의 옵션)

NullPointerException - 값이 null 때에 맵이 null 치를 허가하지 않는 경우 (임의의 옵션)

get

V  get(Object  key)

맵이 지정된 키를 맵 하는 값을 리턴합니다. 맵이 이 키의 매핑을 보관 유지하고 있지 않는 경우는 null을 리턴합니다. 반환값의 null는 맵이 키의 매핑을 보관 유지하고 있지 않는 것을 나타낸다고는 할 수 없습니다. 즉, 맵이 명시적으로 키를 null에 맵 하는 일도 있습니다. containsKey 오퍼레이션을 사용하면, 이러한 2개의 경우를 분별할 수 있습니다 .

즉, 맵에 (key==null ? k==null : key.equals(k)) 라고 하는 조건으로 키 k로 부터 값 v 까지 매핑이 포함되는 경우, 이 메서드는 v를 리턴합니다. 포함되지 않는 경우는 null을 리턴합니다. 이러한 매핑이 1개 만 있습니다.

파라미터:

key - 관련된 값이 리턴된 키

반환값:

맵이, 지정된 키에 매핑 하고 있는 값. 이 키에 대한 매핑이 맵에 없는 경우는 null

예외:

ClassCastException - 키가 맵에 적합하지 않는 형태의 경우 (임의의 옵션)

NullPointerException - 키가 null 때에 맵이 null 키를 허가하지 않는 경우 (임의의 옵션)

관련 항목:

containsKey(Object)

put

V  put(K  key,
      V  value)

지정된 값과 지정된 키를 이 맵에 관련짓습니다 (임의의 오퍼레이션). 맵에 이미 이 키에 대한 매핑이 있는 경우, 낡은 값은 지정된 값으로 옮겨집니다. m.containsKey(k) 가 true를 돌려주는 경우에 한정해, 맵 m는 키 k 매핑을 포함한다고 말할 수 있습니다.

파라미터:

key - 지정되는 값을 관련된 키

value - 지정되는 키에 관련된 값

반환값:

지정된 키에 관련한 이전의 값. key에 매핑이 없었던 경우는 null. 또한, null 반환값은 구현이 null 치를 지원 하고 있는 경우는 지정된 키에 이전 맵이 null을 관련짓고 있던 것을 나타내는 경우도 있다

예외:

UnsupportedOperationException - put 오퍼레이션이 맵에 의해 지원 되어 있지 않은 경우

ClassCastException - 지정된 키 또는 값의 클래스가 원인으로 맵에 포함할 수 없는 경우

IllegalArgumentException - 이 키 또는 값의 특성이 원인으로 맵에 포함할 수 없는 경우

NullPointerException - 맵이 null 키나 null 치를 허가하지 않을 때에 지정된 키 또는 값이 null인 경우

remove

V  remove(Object  key)

이 키에 매핑이 있는 경우에 그 매핑을 맵으로부터 삭제합니다 (임의의 오퍼레이션). 즉, (key==null ? k==null : key.equals(k)) 라고 하는 조건으로 키 k로 부터 값 v 까지 매핑이 맵에 포함되는 경우, 이 매핑은 삭제됩니다. 맵은 이러한 매핑을 1개 만 포함합니다.

키를 이전 관련짓고 있던 맵의 값을 리턴합니다. 이 키의 매핑이 맵에 없는 경우는 null을 리턴합니다 (null 반환값은 구현이 null 치를 지원 하고 있는 경우, 맵이 지정된 키와 null을 이전 관련짓고 있던 것을 나타내는 경우도 있다). 1번 호출이 돌아가면, 맵은 지정된 키의 매핑을 포함하지 않습니다.

파라미터:

key - 매핑이 맵으로부터 삭제되는 키

반환값:

지정된 키와 관련지을 수 있고 있던 이전의 값. 키의 매핑이 없었던 경우는 null

예외:

ClassCastException - 키가 맵에 적합하지 않는 형태의 경우 (임의의 옵션)

NullPointerException - 키가 null 때에 맵이 null 키를 허가하지 않는 경우 (임의의 옵션)

UnsupportedOperationException - 맵이 remove 메서드를 지원 하고 있지 않는 경우

putAll

void putAll(Map <?  extends K,
?  extends V > t)

지정된 맵의 모든 매핑을 이 맵에 카피합니다 (임의의 오퍼레이션). 지정된 맵의 키 k로 부터 값 v 까지의 각 매핑에 관해서, 이 호출의 효과는 맵으로 put(k, v)를 호출했을 경우와 같습니다. 지정된 맵이 이 오퍼레이션의 처리중으로 변경되었을 경우, 그 오퍼레이션의 동작은 지정외가 됩니다.

파라미터:

t - 맵에 포함되는 매핑

예외:

UnsupportedOperationException - 맵이 putAll 메서드를 지원 하고 있지 않는 경우

ClassCastException - 지정된 맵내의 키 또는 값의 클래스가 원인으로 맵에 포함할 수 없는 경우

IllegalArgumentException - 지정된 맵내의 키 또는 값의 특성이 원인으로 맵에 포함할 수 없는 경우

NullPointerException - 지정된 맵이 null 인지, 이 맵이 null 키나 null 치를 허가하지 않는 상태로 지정된 맵에 null 키나 null 값이 포함되는 경우

clear

void clear()

맵으로부터 매핑을 모두 삭제합니다 (임의의 오퍼레이션).

예외:

UnsupportedOperationException - clear가 맵에 의해 지원 되어 있지 않은 경우

keySet

Set <K > keySet()

맵에 포함되고 있는 키의 셋트뷰를 리턴합니다. 세트는 맵과 연동하고 있으므로 맵에 대한 변경은 세트에 반영되어 또 세트에 대한 변경은 맵에 반영됩니다. 세트의 반복 처리중으로 맵이 변경되었을 경우, 반복의 결과는 보증되지 않습니다 (반복자 자신의 remove 오퍼레이션을 제외하다). 세트는 요소의 삭제를 지원 하고 있어, 대응하는 매핑을 맵으로부터 삭제할 수 있습니다. 삭제는 Iterator.remove, Set.remove, removeAll, retainAll 및 retainAll 오퍼레이션을 통해 실시합니다. add 및 addAll 오퍼레이션은 지원 되지 않습니다.

반환값:

맵에 포함되어 있는 키의 셋트뷰

values

Collection <V > values()

맵에 포함되고 있는 값의 코레크션뷰를 리턴합니다. 컬렉션은 맵과 연동하고 있으므로 맵에 대한 변경은 컬렉션에 반영되어 또 컬렉션에 대한 변경은 맵에 반영됩니다. 컬렉션의 반복 처리중으로 맵이 변경되었을 경우, 반복의 결과는 보증되지 않습니다 (반복자 자신의 remove 오퍼레이션을 제외하다). 컬렉션은 요소의 삭제를 지원 하고 있어, 대응하는 매핑을 맵으로부터 삭제할 수 있습니다. 삭제는 Iterator.remove, Collection.remove, removeAll, retainAll 및 clear 오퍼레이션을 통해 실시합니다. add 및 addAll 오퍼레이션은 지원 되지 않습니다.

반환값:

맵내에 포함되어 있는 값의 코레크션뷰

entrySet

Set <Map.Entry <K,
V >> entrySet()

맵에 포함되어 있는 매핑의 셋트뷰를 리턴합니다. 리턴된 세트내의 각 요소는 Map.Entry 입니다. 세트는 맵과 연동하고 있으므로 맵에 대한 변경은 세트에 반영되어 또, 세트에 대한 변경은 맵에 반영됩니다. 세트에 대한 반복의 처리중으로 맵이 변경되었을 경우는 반복의 결과는 보증되지 않습니다 (반복자 자신의 remove 오퍼레이션, 또는 반복자에 의해 리턴된 맵 엔트리에 대한 setValue 오퍼레이션을 제외하다). 세트는 요소의 삭제를 지원 하고 있어, 대응하는 매핑을 맵으로부터 삭제할 수 있습니다. 삭제는 Iterator.remove, Set.remove, removeAll, retainAll 및 clear 각 오퍼레이션을 통해 실시합니다. add 및 addAll 오퍼레이션은 지원 되지 않습니다.

반환값:

맵내에 보관 유지되고 있는 매핑의 셋트뷰

equals

boolean equals(Object  o)

지정된 객체가 이 맵과 동일한지 어떤지를 비교합니다. 지정된 객체도 맵이며, 2개의 Map이 같은 매핑을 나타내고 있는 경우는 true를 리턴합니다. 즉, t1.entrySet(). equals(t2.entrySet()) 인 경우, 2개의 맵 t1와 t2는 같은 매핑을 나타냅니다. 이것에 의해 Map 인터페이스의 구현이 다른 경우에서도, equals 메서드가 올바르게 동작하는 것이 보증됩니다.

오버라이드(override):

클래스 Object 내의 equals

파라미터:

o - 맵과 동일한지 어떤지를 비교하는 객체

반환값:

지정된 객체가 맵과 동일한 경우는 true

관련 항목:

Object.hashCode(), Hashtable

hashCode

int hashCode()

맵의 해시 코드값을 리턴합니다. 맵의 해시 코드는 맵의 entrySet 뷰내의 각 엔트리의 hashCode 합계가 되도록 정의됩니다. 이것에 의해 Object.hashCode 일반 규약에 의해 요구되도록, 임의의 2개의 맵 t1와 t2로 t1.equals(t2) 이면, t1.hashCode() ==t2.hashCode()가 되는 것이 보증됩니다.

오버라이드(override):

클래스 Object 내의 hashCode

반환값:

맵의 해시 코드값

관련 항목:

Map.Entry.hashCode(), Object.hashCode(), Object.equals(Object), equals(Object)