java.util.concurrent
インタフェース ConcurrentNavigableMap<K,V>

型パラメータ:

K - このマップが保持するキーの型

V - マップされる値の型

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

ConcurrentMap<K,V>, Map<K,V>, NavigableMap<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 から継承されたメソッド

putIfAbsent, remove, replace, replace

インタフェース java.util.NavigableMap から継承されたメソッド

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

インタフェース java.util.SortedMap から継承されたメソッド

comparator, entrySet, firstKey, lastKey, values

インタフェース java.util.Map から継承されたメソッド

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

メソッドの詳細

subMap

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

インタフェース NavigableMap の記述:

マップの fromKey 〜 toKey のキー範囲を持つ部分のビューを返します。fromKey と toKey が等しい場合、返されるマップは空になります。ただし、fromExclusive と toExclusive がどちらも 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 オペレーションはサポートされていません。

ビューの iterator は「弱一貫性」を持つ反復子であり、ConcurrentModificationException をスローすることはなく、反復子の構築時に存在した要素をトラバースすることを保証します。また、構築後のすべての変更を反映します (ただし保証されてはいない)。

定義:

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

戻り値:

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

keySet

NavigableSet<K> keySet()

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

ビューの iterator は「弱一貫性」を持つ反復子であり、ConcurrentModificationException をスローすることはなく、反復子の構築時に存在した要素をトラバースすることを保証します。また、構築後のすべての変更を反映します (ただし保証されてはいない)。

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

定義:

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

定義:

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

戻り値:

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

descendingKeySet

NavigableSet<K> descendingKeySet()

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

ビューの iterator は「弱一貫性」を持つ反復子であり、ConcurrentModificationException をスローすることはなく、反復子の構築時に存在した要素をトラバースすることを保証します。また、構築後のすべての変更を反映します (ただし保証されてはいない)。

定義:

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

戻り値:

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