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 が等しい場合、返されるマップは、fromInclusive と toInclusive の両方が true でないかぎり、空になります。返されるマップはこのマップに連動しており、返されるマップでの変更はこのマップに反映され、その逆の場合も同様です。返されるマップは、このマップがサポートする任意のマップオペレーションをすべてサポートします。

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

定義:

subMap、インタフェース: NavigableMap<K,V>

パラメータ:

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 をスローします。

定義:

headMap、インタフェース: NavigableMap<K,V>

パラメータ:

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 をスローします。

定義:

tailMap、インタフェース: NavigableMap<K,V>

パラメータ:

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) と同等です。

定義:

subMap、インタフェース: NavigableMap<K,V>

定義:

subMap、インタフェース: SortedMap<K,V>

パラメータ:

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) と同等です。

定義:

headMap、インタフェース: NavigableMap<K,V>

定義:

headMap、インタフェース: SortedMap<K,V>

パラメータ:

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) と同等です。

定義:

tailMap、インタフェース: NavigableMap<K,V>

定義:

tailMap、インタフェース: SortedMap<K,V>

パラメータ:

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 と同等になります。

定義:

descendingMap、インタフェース: NavigableMap<K,V>

戻り値:

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

navigableKeySet

NavigableSet<K> navigableKeySet()

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

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

定義:

navigableKeySet、インタフェース: NavigableMap<K,V>

戻り値:

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

keySet

NavigableSet<K> keySet()

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

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

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

定義:

keySet、インタフェース: Map<K,V>

定義:

keySet、インタフェース: SortedMap<K,V>

戻り値:

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

descendingKeySet

NavigableSet<K> descendingKeySet()

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

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

定義:

descendingKeySet、インタフェース: NavigableMap<K,V>

戻り値:

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