モジュール java.base

パッケージ java.util.concurrent

インタフェースConcurrentNavigableMap<K,V>

型パラメータ:

K - このマップで保持されるキーの型

V - マップされる値の型

すべてのスーパー・インタフェース:

ConcurrentMap<K,V>, Map<K,V>, NavigableMap<K,V>, SequencedMap<K,V>, SortedMap<K,V>

既知のすべての実装クラス:

ConcurrentSkipListMap

public interface ConcurrentNavigableMap<K,V> extends ConcurrentMap<K,V>, NavigableMap<K,V>

NavigableMapオペレーションをサポートするConcurrentMapです。そのナビゲート可能なサブマップに対しては再帰的です。

このインタフェースは、Java Collections Frameworkのメンバーです。

導入されたバージョン:

1.6

ネストされたクラスのサマリー

インタフェースjava.util.Mapで宣言されたネストされたクラス/インタフェース

Map.Entry<K,V>

メソッドのサマリー

修飾子と型	メソッド	説明
NavigableSet<K>	descendingKeySet()	このマップに含まれるキーの逆順のNavigableSetビューを返します。
ConcurrentNavigableMap<K,V>	descendingMap()	このマップ内に保持されているマッピングの逆順のビューを返します。
ConcurrentNavigableMap<K,V>	headMap(K toKey)	このマップのtoKeyよりも確実に小さいキーを持つ部分のビューを返します。
ConcurrentNavigableMap<K,V>	headMap(K toKey, boolean inclusive)	このマップのtoKeyよりも小さいキー(inclusiveがtrueの場合はそれよりも小さいかそれと等しいキー)を含む部分のビューを返します。
NavigableSet<K>	keySet()	このマップに含まれるキーのNavigableSetビューを返します。
NavigableSet<K>	navigableKeySet()	このマップに含まれるキーのNavigableSetビューを返します。
ConcurrentNavigableMap<K,V>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)	このマップのfromKey - toKeyのキー範囲を持つ部分のビューを返します。
ConcurrentNavigableMap<K,V>	subMap(K fromKey, K toKey)	このマップのfromKey (これを含む) - toKey (これを含まない)のキー範囲を持つ部分のビューを返します。
ConcurrentNavigableMap<K,V>	tailMap(K fromKey)	このマップのfromKey以上のキーを持つ部分のビューを返します。
ConcurrentNavigableMap<K,V>	tailMap(K fromKey, boolean inclusive)	このマップのfromKeyよりも大きいキー(inclusiveがtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビューを返します。

インタフェースjava.util.concurrent.ConcurrentMapで宣言されたメソッド

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

インタフェースjava.util.Mapで宣言されたメソッド

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

インタフェースjava.util.NavigableMapで宣言されたメソッド

ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry, reversed

インタフェースjava.util.SequencedMapで宣言されたメソッド

sequencedEntrySet, sequencedKeySet, sequencedValues

インタフェースjava.util.SortedMapで宣言されたメソッド

comparator, entrySet, firstKey, lastKey, putFirst, putLast, values

メソッドの詳細

subMap

ConcurrentNavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)

インタフェースからコピーされた説明: NavigableMap

このマップのfromKey - toKeyのキー範囲を持つ部分のビューを返します。 fromKeyとtoKeyが等しい場合、返されるマップは、fromInclusiveとtoInclusiveの両方がtrueでないかぎり、空になります。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。

返されるマップは、その範囲外のキーが挿入されようとしたり、端点のいずれかがその範囲外にあるようなサブマップが構築されようとしたりすると、IllegalArgumentExceptionをスローします。

定義:

インタフェースNavigableMap<K,V>内のsubMap

パラメータ:

fromKey - 返されるマップ内のキーの下端点

fromInclusive - 返されるビューに下端点が含まれる場合はtrue

toKey - 返されるマップ内のキーの上端点

toInclusive - 返されるビューに上端点が含まれる場合はtrue

戻り値:

このマップのfromKey - toKeyのキー範囲を持つ部分のビュー

例外:

ClassCastException - このマップのコンパレータを使用して(このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKeyとtoKeyを相互に比較できない場合。 実装は、マップ内に現在存在しているキーとfromKeyまたはtoKeyとを比較できない場合にこの例外をスローできる。ただし、必須ではない。

NullPointerException - fromKeyまたはtoKeyがnullであり、このマップがnullキーを許可しない場合

IllegalArgumentException - fromKeyがtoKeyよりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKeyまたはtoKeyがその範囲から外れている場合

headMap

ConcurrentNavigableMap<K,V> headMap(K toKey, boolean inclusive)

インタフェースからコピーされた説明: NavigableMap

このマップのtoKeyよりも小さいキー(inclusiveがtrueの場合はそれよりも小さいかそれと等しいキー)を含む部分のビューを返します。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。

返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentExceptionをスローします。

定義:

インタフェースNavigableMap<K,V>内のheadMap

パラメータ:

toKey - 返されるマップ内のキーの上端点

inclusive - 返されるビューに上端点が含まれる場合はtrue

戻り値:

このマップのtoKeyよりも小さいキー(inclusiveがtrueの場合はそれよりも小さいかそれと等しいキー)を含む部分のビュー

例外:

ClassCastException - toKeyがこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、toKeyがComparableを実装していない場合)。 実装は、マップ内に現在存在しているキーとtoKeyとを比較できない場合にこの例外をスローできる。ただし、必須ではない

NullPointerException - toKeyがnullであり、このマップがnullキーを許可しない場合

IllegalArgumentException - このマップ自体が制限された範囲を持っており、toKeyがその範囲から外れている場合

tailMap

ConcurrentNavigableMap<K,V> tailMap(K fromKey, boolean inclusive)

インタフェースからコピーされた説明: NavigableMap

このマップのfromKeyよりも大きいキー(inclusiveがtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビューを返します。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。

返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentExceptionをスローします。

定義:

インタフェースNavigableMap<K,V>内のtailMap

パラメータ:

fromKey - 返されるマップ内のキーの下端点

inclusive - 返されるビューに下端点が含まれる場合はtrue

戻り値:

このマップのfromKeyよりも大きいキー(inclusiveがtrueの場合はそれよりも大きいかそれと等しいキー)を含む部分のビュー

例外:

ClassCastException - fromKeyがこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、fromKeyがComparableを実装していない場合)。 実装は、マップ内に現在存在しているキーとfromKeyとを比較できない場合にこの例外をスローできる。ただし、必須ではない

NullPointerException - fromKeyがnullであり、このマップがnullキーを許可しない場合

IllegalArgumentException - このマップ自体が制限された範囲を持っており、fromKeyがその範囲から外れている場合

subMap

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

インタフェースからコピーされた説明: NavigableMap

このマップのfromKey (これを含む) - toKey (これを含まない)のキー範囲を持つ部分のビューを返します。 fromKeyとtoKeyが等しい場合は、空のマップが返されます。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。

返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentExceptionをスローします。

subMap(fromKey, true, toKey, false)と同等です。

定義:

インタフェースNavigableMap<K,V>内のsubMap

定義:

インタフェースSortedMap<K,V>内のsubMap

パラメータ:

fromKey - 返されるマップ内のキーの下端点(これを含む)

toKey - 返されるマップ内のキーの上端点(これを含まない)

戻り値:

このマップのfromKey (これを含む)からtoKey (これを含まない)のキー範囲を持つ部分のビュー

例外:

ClassCastException - このマップのコンパレータを使用して(このマップがコンパレータを持たない場合は自然順序付けを使用して)、fromKeyとtoKeyを相互に比較できない場合。 実装は、マップ内に現在存在しているキーとfromKeyまたはtoKeyとを比較できない場合にこの例外をスローできる。ただし、必須ではない。

NullPointerException - fromKeyまたはtoKeyがnullであり、このマップがnullキーを許可しない場合

IllegalArgumentException - fromKeyがtoKeyよりも大きい場合、またはこのマップ自体が制限された範囲を持っており、fromKeyまたはtoKeyがその範囲から外れている場合

headMap

ConcurrentNavigableMap<K,V> headMap(K toKey)

インタフェースからコピーされた説明: NavigableMap

このマップのtoKeyよりも確実に小さいキーを持つ部分のビューを返します。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。

返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentExceptionをスローします。

headMap(toKey, false)と同等です。

定義:

インタフェースNavigableMap<K,V>内のheadMap

定義:

インタフェースSortedMap<K,V>内のheadMap

パラメータ:

toKey - 返されるマップ内のキーの上端点(これを含まない)

戻り値:

このマップのtoKeyよりも確実に小さいキーを持つ部分のビュー

例外:

ClassCastException - toKeyがこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、toKeyがComparableを実装していない場合)。 実装は、マップ内に現在存在しているキーとtoKeyとを比較できない場合にこの例外をスローできる。ただし、必須ではない

NullPointerException - toKeyがnullであり、このマップがnullキーを許可しない場合

IllegalArgumentException - このマップ自体が制限された範囲を持っており、toKeyがその範囲から外れている場合

tailMap

ConcurrentNavigableMap<K,V> tailMap(K fromKey)

インタフェースからコピーされた説明: NavigableMap

このマップのfromKey以上のキーを持つ部分のビューを返します。 返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。 返されるマップは、このマップがサポートするオプションのマップ・オペレーションをすべてサポートします。

返されるマップは、その範囲外のキーが挿入されようとすると、IllegalArgumentExceptionをスローします。

tailMap(fromKey, true)と同等です。

定義:

インタフェースNavigableMap<K,V>内のtailMap

定義:

インタフェースSortedMap<K,V>内のtailMap

パラメータ:

fromKey - 返されるマップ内のキーの下端点(これを含む)

戻り値:

このマップのfromKey以上のキーを持つ部分のビュー

例外:

ClassCastException - fromKeyがこのマップのコンパレータと互換性がない場合(または、そのマップがコンパレータを持たない場合、fromKeyがComparableを実装していない場合)。 実装は、マップ内に現在存在しているキーとfromKeyとを比較できない場合にこの例外をスローできる。ただし、必須ではない

NullPointerException - fromKeyがnullであり、このマップがnullキーを許可しない場合

IllegalArgumentException - このマップ自体が制限された範囲を持っており、fromKeyがその範囲から外れている場合

descendingMap

ConcurrentNavigableMap<K,V> descendingMap()

このマップ内に保持されているマッピングの逆順のビューを返します。 降順マップはこのマップに連動しており、このマップでの変更は降順マップに反映され、その逆の場合も同様です。

返されるマップの順序付けは、Collections.reverseOrder(comparator())と同等になります。 式m.descendingMap().descendingMap()から返されるmのビューは基本的にmと同等になります。

定義:

インタフェースNavigableMap<K,V>内のdescendingMap

戻り値:

このマップの逆順のビュー

navigableKeySet

NavigableSet<K> navigableKeySet()

このマップに含まれるキーのNavigableSetビューを返します。 セットのイテレータは、キーを昇順で返します。 セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、およびclearオペレーションで対応するマッピングをマップから削除します。 addまたはaddAll操作はサポートされていません。

ビューのイテレータおよびスプリッテレータは、弱一貫性を持っています。

定義:

インタフェースNavigableMap<K,V>内のnavigableKeySet

戻り値:

このマップ内のキーのナビゲート可能なセット・ビュー

keySet

NavigableSet<K> keySet()

このマップに含まれるキーのNavigableSetビューを返します。 セットのイテレータは、キーを昇順で返します。 セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、およびclearオペレーションで対応するマッピングをマップから削除します。 addまたはaddAll操作はサポートされていません。

ビューのイテレータおよびスプリッテレータは、弱一貫性を持っています。

このメソッドは、メソッドnavigableKeySetと同等です。

定義:

インタフェースMap<K,V>内のkeySet

定義:

インタフェースSortedMap<K,V>内のkeySet

戻り値:

このマップ内のキーのナビゲート可能なセット・ビュー

descendingKeySet

NavigableSet<K> descendingKeySet()

このマップに含まれるキーの逆順のNavigableSetビューを返します。 セットのイテレータは、キーを降順で返します。 セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。 セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、およびclearオペレーションで対応するマッピングをマップから削除します。 addまたはaddAll操作はサポートされていません。

ビューのイテレータおよびスプリッテレータは、弱一貫性を持っています。

定義:

インタフェースNavigableMap<K,V>内のdescendingKeySet

戻り値:

このマップ内のキーのナビゲート可能な逆順セット・ビュー