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

모든 슈퍼 인터페이스:

Map <K, V>

알려진 구현 클래스 목록:

TreeMap

public interface SortedMap<K, V>
extends Map <K, V>

맵 자신이 승순의 키 순서가 되는 것을 보증합니다. 다만, 키의 승순은 그 키의 「자연 정렬」(Comparable 인터페이스를 참조)에 따라 소트된 승순, 또는 소트 맵 작성시에 제공되는 컴퍼레이터에 의해 소트된 승순입니다. 이 순서는 소트 맵의 코레크션뷰 (entrySet, keySet, values 메서드에 의해 리턴된다)의 반복 처리시에 반영됩니다. 그 순서부를 이용하기 위해서 추가의 오퍼레이션이 몇개인가 제공되고 있습니다. 이 인터페이스는 SortedSet 인터페이스의 맵에 유사하고 있습니다.

소트 맵에 삽입되는 모든 키는 Comparable 인터페이스를 구현하는지, 지정된 컴퍼레이터에 의해 받아들일 수 있을 필요가 있습니다. 게다가 그러한 모든 키는 「서로 비교 가능」일 필요가 있습니다. 즉, k1.compareTo(k2) (또는 comparator.compare(k1, k2))는 소트 맵내의 임의의 요소 k1와 k2에 대해서도 ClassCastException을 Throw 해야 하지는 않습니다. 이 제약에 위반하면, 그 위반측의 메서드나 생성자 호출은 ClassCastException을 Throw 합니다.

소트 맵이 올바르고 Map 인터페이스를 구현할 필요가 있는 경우는 명시적인 컴퍼레이터 의 제공의 유무에 관계없이, 소트 맵으로 관리되는 순서부는 「equals와 일관성」이 필요합니다 ( 「equals와 의 일관성」의 정확한 정의에 대해서는 Comparable 인터페이스 또는 Comparator 인터페이스를 참조). 이것은 Map 인터페이스가 equals 오퍼레이션에 근거해 정의되기 때문에입니다만, 소트 맵은 그 compareTo 메서드 또는 compare 메서드를 사용해 모든 키 비교를 실행하므로 이 메서드에 의해 등가라고 보여지는 2개의 키는 소트 맵의 견지로부터 하면 같은 것입니다. 트리 맵의 동작은 그 순서부가 equals와 일관성이 없는 경우에서도 명확하게 정의되고 있습니다. 즉, 트리 맵의 동작은 Map 인터페이스의 일반 규약에 따르고 있지 않습니다.

범용의 소트 맵 구현 클래스는 모두, 4개의 표준 생성자를 제공할 필요가 있습니다. 그 4 개이란 1) 그 키의 「자연 정렬」에 따라 소트된 비어있는 소트 맵을 작성하는 void (인수 없음) 생성자, 2) 지정된 컴퍼레이터에 따라 소트된 비어있는 소트 맵을 작성하는 Comparator 형의 인수를 1개 가지는 생성자, 3) 키의 자연 순서부에 따라 소트된, 그 인수와 같은 키와 값의 매핑을 가지는 새로운 맵을 작성하는 Map 형의 인수를 1개 가지는 생성자, 4) 입력의 소트 맵과 같은 키와 값의 매핑과 같은 순서부를 가지는 새로운 소트 맵을 작성하는 소트 맵형의 인수를 1개 가지는 생성자 입니다. 인터페이스는 생성자를 보관 유지할 수 없기 때문에 이것을 강제적으로 추천 할 수 없습니다만, JDK 구현 (TreeMap)은 이것에 준거합니다.

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

도입된 버전 :

1.2

관련 항목:

Map, TreeMap, SortedSet, Comparator, Comparable, Collection, ClassCastException

중첩(Nested) 클래스 개요

인터페이스 java.util. Map 로부터 상속된 중첩(Nested) 클래스/인터페이스

Map.Entry <K, V >

메서드 개요

Comparator <? super K >	comparator () 이 소트 맵에 관련한 컴퍼레이터를 리턴합니다.
K	firstKey () 소트 맵내에 현재 있는 최초 (하단)의 키를 리턴합니다.
SortedMap <K, V >	headMap (K toKey) 소트 맵의 toKey 보다 작은 키를 가지는 부분의 뷰를 리턴합니다.
K	lastKey () 소트 맵내에 현재 있는 최후 (상단)의 키를 리턴합니다.
SortedMap <K, V >	subMap (K fromKey, K toKey) 이 소트 맵의 fromKey (포함한다) ~ toKey (포함하지 않는다)의 키 범위를 가지는 부분의 뷰를 리턴합니다 (fromKey와 toKey가 같은 경우는 비어있는 소트 맵이 리턴된다).
SortedMap <K, V >	tailMap (K fromKey) 소트 맵의 fromKey 이상의 키를 가지는 부분의 뷰를 리턴합니다.

인터페이스 java.util. Map 로부터 상속된 메서드

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

메서드의 상세

comparator

Comparator <?  super K > comparator()

이 소트 맵에 관련한 컴퍼레이터를 리턴합니다. 다만, 그 키의 자연 순서부를 사용하는 경우는 null을 리턴합니다.

반환값:

이 소트 맵에 관련한 컴퍼레이터. 다만, 그 키의 자연 순서부를 사용하는 경우는 null

subMap

SortedMap <K,
V > subMap(K  fromKey,
                      K  toKey)

이 소트 맵의 fromKey (포함한다) ~ toKey (포함하지 않는다)의 키 범위를 가지는 부분의 뷰를 리턴합니다 (fromKey와 toKey가 같은 경우는 비어있는 소트 맵이 리턴된다). 리턴된 소트 맵은 이 소트 맵에 근거하고 있어 리턴된 소트 맵에서의 변경은 이 소트 맵에 반영되어 이 반대도 성립됩니다. 리턴된 Map는 이 소트 맵이 지원하는 임의의 맵 오퍼레이션을 모두 지원 합니다.

이 메서드에 의해 리턴된 맵은 사용자가 키가 지정된 범위외에 삽입하려고 하면 IllegalArgumentException을 Throw 합니다.

주: 이 메서드는 항상, 그 하단점은 포함하지만 상단점은 포함하지 않는 「한쪽 편이 열린 범위」를 리턴합니다. 상하단점을 포함한 「닫은 범위」가 필요해, 키의 형태에 의해 직후의 키의 계산이 가능한 경우, 단지 lowEndpoint로 부터 직후의 키 (highEndpoint)까지의 부분 범위를 지정해 주세요. 예를 들어, m는 그 키가 캐릭터 라인의 맵인 경우, 다음의 관용법은 키가 low ~ high 까지의 범위 (상하단점을 포함한다)에 있는 m 내의 모든 키와 값의 매핑을 보관 유지하는 뷰를 취득합니다.

    Map sub = m.subMap(low, high+"\0");

같은 테크닉을 사용해, 상하단점의 어느쪽이나 포함하지 않는 「연 범위」를 생성할 수 있습니다. 다음의 관용법은 키가 low ~ high 까지의 범위 (상하단점을 포함하지 않는다)에 있는 m 내의 모든 키와 값의 매핑을 보관 유지하는 뷰를 취득합니다.

    Map sub = m.subMap(low+"\0", high);

파라미터:

fromKey - subMap 하단점 (이것을 포함한다)

toKey - subMap 상단점 (이것을 포함하지 않는다)

반환값:

이 소트 맵내의 지정된 범위의 뷰

예외:

ClassCastException - 이 맵의 컴퍼레이터를 사용해, fromKey 및 toKey를 서로 비교할 수 없는 경우 (또는 맵에 자연 순서부를 사용하는 컴퍼레이터가 없는 경우). fromKey 또는 toKey를 맵의 현재의 키와 비교할 수 없는 경우, 반드시 요구되는 것은 아니지만, 이 예외가 발생되는 경우가 있다

IllegalArgumentException - fromKey가 toKey 보다 큰 경우. 또는 이 맵 자체가 subMap, headMap, 또는 tailMap 로fromKey 또는 toKey가 지정한 범위의 subMap, headMap, 또는 tailMap에 없는 경우

NullPointerException - fromKey 또는 toKey가 null로 이 소트 맵이 null 키를 허용 하지 않는 경우

headMap

SortedMap <K,
V > headMap(K  toKey)

소트 맵의 toKey 보다 작은 키를 가지는 부분의 뷰를 리턴합니다. 리턴된 소트 맵은 이 소트 맵에 근거하고 있어 리턴된 소트 맵에서의 변경은 이 소트 맵에 반영되어 그 역도 성립됩니다. 리턴된 맵은 소트 맵이 지원하는 옵션의 맵 오퍼레이션을 모두 지원 합니다.

이 메서드에 의해 리턴된 맵은 사용자가 키가 지정된 범위외에 삽입하려고 하면 IllegalArgumentException을 Throw 합니다.

주: 이 메서드는 항상, 그 (상)단점을 포함하지 않는 뷰를 리턴합니다. 이 단 점을 포함한 뷰를 필요로 해, 키의 형태에 의해 직후의 키의 계산이 가능하게 되는 경우는 단지 직후의 키 (highEndpoint)에 의해 한계를 설치된 headMap를 지정해 주세요. 예를 들어, m는 그 키가 캐릭터 라인의 맵인 경우, 다음의 관용법은 키가 high 아래의 m 내의 모든 키와 값의 매핑을 보관 유지하는 뷰를 취득합니다.

    Map head = m.headMap(high+"\0");

파라미터:

toKey - subMap 상단점 (이것을 포함하지 않는다)

반환값:

소트 맵의 지정된 초기 범위의 뷰

예외:

ClassCastException - toKey가 이 맵의 컴퍼레이터와 호환성이 없는 경우 (또는 맵에 컴퍼레이터가 없는 경우, toKey에 Comparable가 구현되어 있지 않은 경우). toKey가 맵의 현재의 키와 비교할 수 없는 경우, 반드시 요구되는 것은 아니지만, 이 예외가 발생되는 경우가 있다

IllegalArgumentException - 이 맵 자체가 subMap, headMap, 또는 tailMap 로toKey가 지정한 범위의 subMap, headMap, 또는 tailMap에 없는 경우

NullPointerException - toKey가 null로 소트 맵이 null 키를 허용 하지 않는 경우

tailMap

SortedMap <K,
V > tailMap(K  fromKey)

소트 맵의 fromKey 이상의 키를 가지는 부분의 뷰를 리턴합니다. 리턴된 소트 맵은 이 소트 맵에 근거하고 있어 리턴된 소트 맵에서의 변경은 이 소트 맵에 반영되어 그 역도 성립됩니다. 리턴된 맵은 소트 맵이 지원하는 옵션의 맵 오퍼레이션을 모두 지원 합니다.

이 메서드에 의해 리턴된 맵은 사용자가 키가 지정된 범위외에 삽입하려고 하면 IllegalArgumentException을 Throw 합니다.

주: 이 메서드는 항상, 그 (하)단점을 포함한 뷰를 리턴합니다. 이 단 점을 포함하지 않는 뷰를 필요로 해, 요소의 형태에 의해 직후의 요소의 계산이 가능한 경우, 단지직후의 값 (lowEndpoint)에 의해 한계를 설치된 tailMap를 지정해 주세요. 예를 들어, m는 그 키가 캐릭터 라인의 맵인 경우, 다음의 관용법은 키가 low 보다 큰 m 내의 모든 키와 값의 매핑을 보관 유지하는 뷰를 취득합니다.

    Map tail = m.tailMap(low+"\0");

파라미터:

fromKey - tailMap 하단점 (이것을 포함한다)

반환값:

소트 맵의 지정된 최종 범위의 뷰

예외:

ClassCastException - fromKey가 이 맵의 컴퍼레이터와 호환성이 없는 경우 (또는 맵에 컴퍼레이터가 없는 경우, fromKey에 Comparable가 구현되어 있지 않은 경우). fromKey가 맵의 현재의 키와 비교할 수 없는 경우, 반드시 요구되는 것은 아니지만, 이 예외가 발생되는 경우가 있다

IllegalArgumentException - 이 맵 자체가 subMap, headMap, 또는 tailMap 로fromKey가 지정한 범위의 subMap, headMap, 또는 tailMap에 없는 경우

NullPointerException - fromKey가 null로 소트 맵이 null 키를 허용 하지 않는 경우

firstKey

K  firstKey()

소트 맵내에 현재 있는 최초 (하단)의 키를 리턴합니다.

반환값:

소트 맵내에 현재 있는 최초 (하단)의 키

예외:

NoSuchElementException - 맵이 비어있는 경우

lastKey

K  lastKey()

소트 맵내에 현재 있는 최후 (상단)의 키를 리턴합니다.

반환값:

소트 맵내에 현재 있는 최후 (상단)의 키

예외:

NoSuchElementException - 맵이 비어있는 경우