NavigableSet (Java Platform SE 8)

型パラメータ:

E - このセットで保持される要素の型

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

Collection<E>, Iterable<E>, Set<E>, SortedSet<E>

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

ConcurrentSkipListSet, TreeSet
```
public interface NavigableSet<E>
extends SortedSet<E>
```
指定の検索ターゲットにもっとも近い一致内容を報告するナビゲーション・メソッドで拡張されたSortedSetです。lower、floor、ceiling、higherメソッドはそれぞれ、指定された要素よりも小さい要素、小さいか等しい要素、大きいか等しい要素、大きい要素を返します。ただし、そのような要素が存在しない場合はnullを返します。昇順または降順の順序で、NavigableSetがアクセスしたり、トラバースしたりできる。descendingSetメソッドから返されるこのセットのビューでは、関係や方向に関するメソッドがすべて反転されたかのように感じられます。オペレーションやビューのパフォーマンスは通常、降順よりも昇順のほうが高速になります。このインタフェースにはさらに、pollFirstとpollLastメソッドも定義されています。これらのメソッドはそれぞれ、最下位の要素、最上位の要素が存在する場合はそれを返して削除し、それ以外の場合はnullを返します。subSet、headSet、およびtailSetメソッドは、下限と上限を含めるかどうかを記述する追加の引数を受け取るという点で、SortedSetの類似の名前を持つメソッドとは異なります。どのNavigableSetのサブセットでもNavigableSetインタフェースを実装する必要があります。
null要素を許可する実装では、ナビゲーション・メソッドの戻り値があいまいになる可能性があります。ただし、その場合でも、contains(null)をチェックすることで、その結果のあいまいさを明確にできます。そのような問題を回避するため、このインタフェースの実装では、null要素の挿入を許可しないようにすることをお薦めします。(Comparable要素から成るソート・セットは本来、nullを許可しません。)
subSet(E, E)、headSet(E)、およびtailSet(E)メソッドがSortedSetを返す仕様になっているのは、既存のSortedSet実装を互換性を維持しながら改良してNavigableSetを実装できるようにするためです。ただし、このインタフェースの拡張や実装では、これらのメソッドをオーバーライドしてNavigableSetが返されるようにすることをお薦めします。
このインタフェースは、Java Collections Frameworkのメンバーです。

導入されたバージョン:

1.6

メソッドのサマリー

すべてのメソッドインスタンス・メソッド抽象メソッド
修飾子と型	メソッドと説明
`E`	`ceiling(E e)` このセット内で、指定された要素と等しいかそれよりも大きい要素の中で最小のものを返します。そのような要素が存在しない場合は`null`を返します。
`Iterator<E>`	`descendingIterator()` このセットの要素のイテレータを降順で返します。
`NavigableSet<E>`	`descendingSet()` このセットに含まれる要素の逆順のビューを返します。
`E`	`floor(E e)` このセット内で、指定された要素と等しいかそれよりも小さい要素の中で最大のものを返します。そのような要素が存在しない場合は`null`を返します。
`SortedSet<E>`	`headSet(E toElement)` このセットの`toElement`よりも確実に小さい要素を持つ部分のビューを返します。
`NavigableSet<E>`	`headSet(E toElement, boolean inclusive)` このセットの`toElement`よりも小さい要素(`inclusive`がtrueの場合はそれよりも小さいかそれと等しい要素)を含む部分のビューを返します。
`E`	`higher(E e)` このセット内で、指定された要素よりも確実に大きい要素の中で最小のものを返します。そのような要素が存在しない場合は`null`を返します。
`Iterator<E>`	`iterator()` このセットの要素のイテレータを昇順で返します。
`E`	`lower(E e)` このセット内で、指定された要素よりも確実に小さい要素の中で最大のものを返します。そのような要素が存在しない場合は`null`を返します。
`E`	`pollFirst()` 最初(下端)の要素を取得して削除します。このセットが空の場合は`null`を返します。
`E`	`pollLast()` 最後(上端)の要素を取得して削除します。このセットが空の場合は`null`を返します。
`NavigableSet<E>`	`subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)` このセットの`fromElement` - `toElement`の要素範囲を持つ部分のビューを返します。
`SortedSet<E>`	`subSet(E fromElement, E toElement)` このセットの`fromElement` (これを含む) - `toElement` (これを含まない)の要素範囲を持つ部分のビューを返します。
`SortedSet<E>`	`tailSet(E fromElement)` このセットの`fromElement`に等しいかそれよりも大きい要素を持つ部分のビューを返します。
`NavigableSet<E>`	`tailSet(E fromElement, boolean inclusive)` このセットの`fromElement`よりも大きい要素(`inclusive`がtrueの場合はそれよりも大きいかそれと等しい要素)を含む部分のビューを返します。

インタフェース java.util.SortedSetから継承されたメソッド
comparator, first, last, spliterator

インタフェース java.util.Setから継承されたメソッド
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

インタフェース java.util.Collectionから継承されたメソッド
parallelStream, removeIf, stream

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

- メソッドの詳細
  - lower
```
E lower(E e)
```
    このセット内で、指定された要素よりも確実に小さい要素の中で最大のものを返します。そのような要素が存在しない場合はnullを返します。
    
    パラメータ:
    
    e - 照合する値
    
    戻り値:
    
    eよりも小さい要素の中で最大のもの。そのような要素が存在しない場合はnull
    
    例外:
    
    ClassCastException - 指定された要素を、セット内に現在存在している要素と比較できない場合
    
    NullPointerException - 指定された要素がnullであり、このセットがnull要素を許可しない場合
  - floor
```
E floor(E e)
```
    このセット内で、指定された要素と等しいかそれよりも小さい要素の中で最大のものを返します。そのような要素が存在しない場合はnullを返します。
    
    パラメータ:
    
    e - 照合する値
    
    戻り値:
    
    eと等しいか、それよりも小さい要素の中で最大のもの。そのような要素が存在しない場合はnull
    
    例外:
    
    ClassCastException - 指定された要素を、セット内に現在存在している要素と比較できない場合
    
    NullPointerException - 指定された要素がnullであり、このセットがnull要素を許可しない場合
  - ceiling
```
E ceiling(E e)
```
    このセット内で、指定された要素と等しいかそれよりも大きい要素の中で最小のものを返します。そのような要素が存在しない場合はnullを返します。
    
    パラメータ:
    
    e - 照合する値
    
    戻り値:
    
    eと等しいか、それよりも大きい要素の中で最小のもの。そのような要素が存在しない場合はnull
    
    例外:
    
    ClassCastException - 指定された要素を、セット内に現在存在している要素と比較できない場合
    
    NullPointerException - 指定された要素がnullであり、このセットがnull要素を許可しない場合
  - higher
```
E higher(E e)
```
    このセット内で、指定された要素よりも確実に大きい要素の中で最小のものを返します。そのような要素が存在しない場合はnullを返します。
    
    パラメータ:
    
    e - 照合する値
    
    戻り値:
    
    eよりも大きい要素の中で最小のもの。そのような要素が存在しない場合はnull
    
    例外:
    
    ClassCastException - 指定された要素を、セット内に現在存在している要素と比較できない場合
    
    NullPointerException - 指定された要素がnullであり、このセットがnull要素を許可しない場合
  - pollFirst
```
E pollFirst()
```
    最初(下端)の要素を取得して削除します。このセットが空の場合はnullを返します。
    
    戻り値:
    
    最初の要素。このセットが空の場合はnull
  - pollLast
```
E pollLast()
```
    最後(上端)の要素を取得して削除します。このセットが空の場合はnullを返します。
    
    戻り値:
    
    最後の要素。このセットが空の場合はnull
  - iterator
```
Iterator<E> iterator()
```
    このセットの要素のイテレータを昇順で返します。
    
    定義:
    
    iterator、インタフェース: Collection<E>
    
    定義:
    
    iterator、インタフェース: Iterable<E>
    
    定義:
    
    iterator、インタフェース: Set<E>
    
    戻り値:
    
    昇順の、このセットの要素のイテレータ
  - descendingSet
```
NavigableSet<E> descendingSet()
```
    このセットに含まれる要素の逆順のビューを返します。降順セットはこのセットに連動しており、このセットでの変更は降順セットに反映され、その逆の場合も同様です。いずれかのセットの反復処理中にいずれかのセットが変更された場合、反復処理の結果は定義されていません(イテレータ自身のremoveオペレーションを除く)。
    返されるセットの順序付けは、Collections.reverseOrder(comparator())と同等になります。式s.descendingSet().descendingSet()から返されるsのビューは基本的にsと同等になります。
    
    戻り値:
    
    このセットの逆順のビュー
  - descendingIterator
```
Iterator<E> descendingIterator()
```
    このセットの要素のイテレータを降順で返します。実質的にdescendingSet().iterator()と同等です。
    
    戻り値:
    
    降順の、このセットの要素のイテレータ
  - subSet
```
NavigableSet<E> subSet(E fromElement,
                       boolean fromInclusive,
                       E toElement,
                       boolean toInclusive)
```
    このセットのfromElement - toElementの要素範囲を持つ部分のビューを返します。fromElementとtoElementが等しい場合、返されるセットは、fromInclusiveとtoInclusiveの両方がtrueでないかぎり、空になります。返されるセットはこのセットに連動しており、返されるセットでの変更はこのセットに反映され、その逆の場合も同様です。返されるセットは、このセットがサポートする任意のセット・オペレーションをすべてサポートします。
    返されるセットは、その範囲外の要素が挿入されようとすると、IllegalArgumentExceptionをスローします。
    
    パラメータ:
    
    fromElement - 返されるセットの下端点
    
    fromInclusive - 返されるビューに下端点が含まれる場合はtrue
    
    toElement - 返されるセットの上端点
    
    toInclusive - 返されるビューに上端点が含まれる場合はtrue
    
    戻り値:
    
    このセットのfromElement (これを含む) - toElement (これを含まない)の要素範囲を持つ部分のビュー
    
    例外:
    
    ClassCastException - このセットのコンパレータを使用して(このセットがコンパレータを持たない場合は自然順序付けを使用して)、fromElementとtoElementを相互に比較できない場合。実装は、セット内に現在存在している要素とfromElementまたはtoElementとを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - fromElementまたはtoElementがnullであり、このセットがnull要素を許可しない場合
    
    IllegalArgumentException - fromElementがtoElementよりも大きい場合、またはこのセット自体が制限された範囲を持っており、fromElementまたはtoElementがその範囲から外れている場合
  - headSet
```
NavigableSet<E> headSet(E toElement,
                        boolean inclusive)
```
    このセットのtoElementよりも小さい要素(inclusiveがtrueの場合はそれよりも小さいかそれと等しい要素)を含む部分のビューを返します。返されるセットはこのセットに連動しており、返されるセットでの変更はこのセットに反映され、その逆の場合も同様です。返されるセットは、このセットがサポートする任意のセット・オペレーションをすべてサポートします。
    返されるセットは、その範囲外の要素が挿入されようとすると、IllegalArgumentExceptionをスローします。
    
    パラメータ:
    
    toElement - 返されるセットの上端点
    
    inclusive - 返されるビューに上端点が含まれる場合はtrue
    
    戻り値:
    
    このセットのtoElementよりも小さい要素(inclusiveがtrueの場合はそれよりも小さいかそれと等しい要素)を含む部分のビュー
    
    例外:
    
    ClassCastException - toElementがこのセットのコンパレータと互換性がない場合(または、そのセットがコンパレータを持たない場合、toElementがComparableを実装していない場合)。実装は、セット内に現在存在している要素とtoElementとを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - toElementがnullであり、このセットがnull要素を許可しない場合
    
    IllegalArgumentException - このセット自体が制限された範囲を持っており、toElementがその範囲から外れている場合
  - tailSet
```
NavigableSet<E> tailSet(E fromElement,
                        boolean inclusive)
```
    このセットのfromElementよりも大きい要素(inclusiveがtrueの場合はそれよりも大きいかそれと等しい要素)を含む部分のビューを返します。返されるセットはこのセットに連動しており、返されるセットでの変更はこのセットに反映され、その逆の場合も同様です。返されるセットは、このセットがサポートする任意のセット・オペレーションをすべてサポートします。
    返されるセットは、その範囲外の要素が挿入されようとすると、IllegalArgumentExceptionをスローします。
    
    パラメータ:
    
    fromElement - 返されるセットの下端点
    
    inclusive - 返されるビューに下端点が含まれる場合はtrue
    
    戻り値:
    
    このセットのfromElementに等しいかそれよりも大きい要素を持つ部分のビュー
    
    例外:
    
    ClassCastException - fromElementがこのセットのコンパレータと互換性がない場合(または、そのセットがコンパレータを持たない場合、fromElementがComparableを実装していない場合)。実装は、セット内に現在存在している要素とfromElementとを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - fromElementがnullであり、このセットがnull要素を許可しない場合
    
    IllegalArgumentException - このセット自体が制限された範囲を持っており、fromElementがその範囲から外れている場合
  - subSet
```
SortedSet<E> subSet(E fromElement,
                    E toElement)
```
    このセットのfromElement (これを含む) - toElement (これを含まない)の要素範囲を持つ部分のビューを返します。fromElementとtoElementが等しい場合は、空のセットが返されます。返されるセットはこのセットに連動しており、返されるセットでの変更はこのセットに反映され、その逆の場合も同様です。返されるセットは、このセットがサポートする任意のセット・オペレーションをすべてサポートします。
    返されるセットは、その範囲外の要素が挿入されようとすると、IllegalArgumentExceptionをスローします。
    subSet(fromElement, true, toElement, false)と同等です。
    
    定義:
    
    subSet、インタフェース: SortedSet<E>
    
    パラメータ:
    
    fromElement - 返されるセットの下端点(これを含む)
    
    toElement - 返されるセットの上端点(これを含まない)
    
    戻り値:
    
    このセットのfromElement (これを含む) - toElement (これを含まない)の要素範囲を持つ部分のビュー
    
    例外:
    
    ClassCastException - このセットのコンパレータを使用して(このセットがコンパレータを持たない場合は自然順序付けを使用して)、fromElementとtoElementを相互に比較できない場合。実装は、セット内に現在存在している要素とfromElementまたはtoElementとを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - fromElementまたはtoElementがnullであり、このセットがnull要素を許可しない場合
    
    IllegalArgumentException - fromElementがtoElementよりも大きい場合、またはこのセット自体が制限された範囲を持っており、fromElementまたはtoElementがその範囲から外れている場合
  - headSet
```
SortedSet<E> headSet(E toElement)
```
    このセットのtoElementよりも確実に小さい要素を持つ部分のビューを返します。返されるセットはこのセットに連動しており、返されるセットでの変更はこのセットに反映され、その逆の場合も同様です。返されるセットは、このセットがサポートする任意のセット・オペレーションをすべてサポートします。
    返されるセットは、その範囲外の要素が挿入されようとすると、IllegalArgumentExceptionをスローします。
    headSet(toElement, false)と同等です。
    
    定義:
    
    headSet、インタフェース: SortedSet<E>
    
    パラメータ:
    
    toElement - 返されるセットの上端点(これを含まない)
    
    戻り値:
    
    このセットのtoElementよりも確実に小さい要素を持つ部分のビュー
    
    例外:
    
    ClassCastException - toElementがこのセットのコンパレータと互換性がない場合(または、そのセットがコンパレータを持たない場合、toElementがComparableを実装していない場合)。実装は、セット内に現在存在している要素とtoElementとを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - toElementがnullであり、このセットがnull要素を許可しない場合
    
    IllegalArgumentException - このセット自体が制限された範囲を持っており、toElementがその範囲から外れている場合
  - tailSet
```
SortedSet<E> tailSet(E fromElement)
```
    このセットのfromElementに等しいかそれよりも大きい要素を持つ部分のビューを返します。返されるセットはこのセットに連動しており、返されるセットでの変更はこのセットに反映され、その逆の場合も同様です。返されるセットは、このセットがサポートする任意のセット・オペレーションをすべてサポートします。
    返されるセットは、その範囲外の要素が挿入されようとすると、IllegalArgumentExceptionをスローします。
    tailSet(fromElement, true)と同等です。
    
    定義:
    
    tailSet、インタフェース: SortedSet<E>
    
    パラメータ:
    
    fromElement - 返されるセットの下端点(これを含む)
    
    戻り値:
    
    このセットのfromElementに等しいかそれより大きい要素を持つ部分のビュー
    
    例外:
    
    ClassCastException - fromElementがこのセットのコンパレータと互換性がない場合(または、そのセットがコンパレータを持たない場合、fromElementがComparableを実装していない場合)。実装は、セット内に現在存在している要素とfromElementとを比較できない場合にこの例外をスローできる。ただし、必須ではない。
    
    NullPointerException - fromElementがnullであり、このセットがnull要素を許可しない場合
    
    IllegalArgumentException - このセット自体が制限された範囲を持っており、fromElementがその範囲から外れている場合

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

インタフェースNavigableSet<E>

メソッドのサマリー

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

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

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

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

メソッドの詳細

lower

floor

ceiling

higher

pollFirst

pollLast

iterator

descendingSet

descendingIterator

subSet

headSet

tailSet

subSet

headSet

tailSet