インタフェース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

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

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

    Map.Entry<K,V>
    修飾子と型
    インタフェース
    説明
    static interface 
    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の場合はそれよりも大きいかそれと等しいキー)を含む部分のビューを返します。

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

    compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
    修飾子と型
    メソッド
    説明
    default V
    compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
    指定されたキーとその現在のマップされた値のマッピングをコンピュートしようとします。現在のマッピング(オプションの操作)がない場合はnullです。
    default V
    computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction)
    指定されたキーが値(または、nullにマップされます。)にまだ関連付けられていない場合、指定されたマッピング関数を使用してその値をコンピュートし、null (オプションの操作)でないかぎりこのマップに入力します。
    default V
    computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
    指定されたキーの値が存在し、null以外の場合は、キーとその現在のマップされた値(オプションの操作)を指定して、新しいマッピングのコンピュートを試みます。
    default void
    forEach(BiConsumer<? super K, ? super V> action)
    このマップのすべてのエントリの処理が完了するかアクションから例外がスローされるまで、各エントリに対して指定されたアクションを実行します。
    default V
    getOrDefault(Object key, V defaultValue)
    指定されたキーがマップされている値を返します。このマップにそのキーのマッピングが含まれていない場合はdefaultValueを返します。
    default V
    merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)
    指定されたキーがまだ値に関連付けられていない場合、またはnullに関連付けられている場合は、指定されたnull以外の値(オプションの操作)に関連付けます。
    V
    putIfAbsent(K key, V value)
    指定されたキーがまだ値と関連付けられていない場合は、指定された値に関連付けます。
    boolean
    remove(Object key, Object value)
    指定された値にキーが現在マッピングされている場合にのみ、そのキーのエントリを削除します。
    V
    replace(K key, V value)
    キーが値に現在マッピングされている場合にのみ、そのキーのエントリを置換します。
    boolean
    replace(K key, V oldValue, V newValue)
    指定された値にキーが現在マッピングされている場合にのみ、そのキーのエントリを置換します。
    default void
    replaceAll(BiFunction<? super K, ? super V, ? extends V> function)
    すべてのエントリが処理されるか、関数が例外(オプションの操作)をスローするまで、各エントリの値を、そのエントリの指定された関数を呼び出した結果に置き換えます。

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

    clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size
    修飾子と型
    メソッド
    説明
    void
    clear()
    マップからマッピングをすべて削除します(オプションの操作)。
    boolean
    containsKey(Object key)
    指定されたキーのマッピングがこのマップに含まれている場合にtrueを返します。
    boolean
    containsValue(Object value)
    このマップが1つまたは複数のキーと指定された値をマッピングしている場合にtrueを返します。
    boolean
    equals(Object o)
    指定されたオブジェクトがこのマップと等しいかどうかを比較します。
    V
    get(Object key)
    指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合はnullを返します。
    int
    hashCode()
    マップのハッシュ・コード値を返します。
    boolean
    isEmpty()
    このマップがキーと値のマッピングを保持しない場合にtrueを返します。
    V
    put(K key, V value)
    指定された値と指定されたキーをこのマップで関連付けます(オプションの操作)。
    void
    putAll(Map<? extends K, ? extends V> m)
    指定されたマップのすべてのマッピングをこのマップにコピーします(オプションの操作)。
    V
    remove(Object key)
    このマップからキーのマッピング(ある場合)を削除します(オプションの操作)。
    int
    size()
    このマップ内のキー値マッピングの数を返します。

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

    ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry, reversed
    修飾子と型
    メソッド
    説明
    Map.Entry<K,V>
    ceilingEntry(K key)
    指定されたキー以上の、最小のキーと関連するキーと値のマッピングを返します。そのようなキーが存在しない場合は、nullを返します。
    K
    ceilingKey(K key)
    指定されたキーと等しいかそれよりも大きいキーの中で最小のものを返します。そのようなキーが存在しない場合はnullを返します。
    Map.Entry<K,V>
    firstEntry()
    このマップ内の最小のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、nullを返します。
    Map.Entry<K,V>
    floorEntry(K key)
    指定されたキー以下の、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、nullを返します。
    K
    floorKey(K key)
    指定されたキーと等しいかそれよりも小さいキーの中で最大のものを返します。そのようなキーが存在しない場合はnullを返します。
    Map.Entry<K,V>
    higherEntry(K key)
    指定されたキーよりも確実に大きい、最小のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、nullを返します。
    K
    higherKey(K key)
    指定されたキーよりも確実に大きいキーの中で最小のものを返します。そのようなキーが存在しない場合はnullを返します。
    Map.Entry<K,V>
    lastEntry()
    このマップ内の最大のキーに関連付けられたキーと値のマッピングを返します。マップが空の場合、nullを返します。
    Map.Entry<K,V>
    lowerEntry(K key)
    指定されたキーよりも確実に小さい、最大のキーに関連付けられたキーと値のマッピングを返します。そのようなキーが存在しない場合は、nullを返します。
    K
    lowerKey(K key)
    指定されたキーよりも確実に小さいキーの中で最大のものを返します。そのようなキーが存在しない場合はnullを返します。
    Map.Entry<K,V>
    pollFirstEntry()
    このマップ内の最も小さいキーに関連付けられたキーと値のマッピングを削除して返します。マップが空の(オプションの操作)の場合はnullを返します。
    Map.Entry<K,V>
    pollLastEntry()
    このマップ内の最も大きいキーに関連付けられているキーと値のマッピングを削除して返します。マップが空の(オプションの操作)の場合はnullを返します。
    default NavigableMap<K,V>
    reversed()
    このマップの逆順viewを返します。

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

    sequencedEntrySet, sequencedKeySet, sequencedValues
    修飾子と型
    メソッド
    説明
    default SequencedSet<Map.Entry<K,V>>
    sequencedEntrySet()
    このマップのentrySetのSequencedSetビューを返します。
    default SequencedSet<K>
    sequencedKeySet()
    このマップのkeySetのSequencedSetビューを返します。
    default SequencedCollection<V>
    sequencedValues()
    このマップのvaluesコレクションのSequencedCollectionビューを返します。

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

    comparator, entrySet, firstKey, lastKey, putFirst, putLast, values
    修飾子と型
    メソッド
    説明
    Comparator<? super K>
    comparator()
    このマップ内のキーを順序付けするのに使うコンパレータを返します。ただし、このマップがそのキーの自然順序付けを使う場合はnullを返します。
    Set<Map.Entry<K,V>>
    entrySet()
    このマップに含まれるマッピングのSetビューを返します。
    K
    firstKey()
    マップ内に現在ある最初(下端)のキーを返します。
    K
    lastKey()
    マップ内に現在ある最後(上端)のキーを返します。
    default V
    putFirst(K k, V v)
    UnsupportedOperationExceptionをスローします。
    default V
    putLast(K k, V v)
    UnsupportedOperationExceptionをスローします。
    Collection<V>
    values()
    このマップに含まれる値のCollectionビューを返します。

  • メソッドの詳細

    • 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
      戻り値:
      このマップの逆順のビュー

    • 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
      戻り値:
      このマップ内のキーのナビゲート可能な逆順セット・ビュー