インタフェースNavigableSet<E>

型パラメータ:

E - このセットによって保守される要� のタイプ

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

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

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

ConcurrentSkipListSet, TreeSet

public interface NavigableSet<E> extends SortedSet<E>

指定の検索ターゲットにもっとも近い一致内容を� �告するナビゲーション・メソッドで拡張されたSortedSetです。 メソッドlower(E)、floor(E)、ceiling(E)およびhigher(E)は、それぞれ指定された要� より小さい、小さい、等しい、大きいまたは等しい、および大きい要� を返し、そのような要� がない� �合はnullを返します。

昇� �または降� �の� �序で、NavigableSetがアクセスしたり、トラバースしたりできる。 descendingSet()メソッドは、すべてのリレーショナル・メソッドと方向メソッドの感覚を反転させたセットのビューを返します。 オペレーションやビューのパフォーマンスは通常、降� �よりも昇� �のほうが高速になります。 このインタフェースでは、最下位要� と最上位要� (存在する� �合)を返して削除するメソッドpollFirst()およびpollLast()をさらに定義し、それ以外の� �合はnullを返します。 メソッドsubSet(E, boolean, E, boolean)、headSet(E, boolean)およびtailSet(E, boolean)は、下限と上限が包含的か排他的かを記述する追� の引数を受け入れる際の、同じ名前の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を返します。
default E	removeFirst()	このコレクションの最初の要� を削除して返します(オプションの操作)。
default E	removeLast()	このコレクションの最後の要� を削除して返します(オプションの操作)。
default NavigableSet<E>	reversed()	このコレクションの逆� �viewを返します。
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.Collectionで宣言されたメソッド

parallelStream, removeIf, stream, toArray

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

forEach

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

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

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

addFirst, addLast, comparator, first, getFirst, getLast, last, spliterator

メソッドの詳細

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

スロー:

UnsupportedOperationException - pollFirst操作がこのコレクションでサポートされていない� �合

pollLast

E pollLast()

最後の(最高)要� を取得して削除するか、このセットが空の(オプションの操作)の� �合はnullを返します。

戻り値:

最後の要� 。このセットが空の� �合はnull

スロー:

UnsupportedOperationException - pollLast操作がこのコレクションでサポートされていない� �合

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がその範囲から外れている� �合

removeFirst

default E removeFirst()

このコレクションの最初の要� を削除して返します(オプションの操作)。

定義:

インタフェースSequencedCollection<E>内のremoveFirst

定義:

インタフェースSortedSet<E>内のremoveFirst

実装要件:

このセットが空でない� �合、このインタフェースの実装は、pollFirstメソッドをコールした結果を返します。 それ以外の� �合は、NoSuchElementExceptionがスローされます。

戻り値:

削除される要�

スロー:

NoSuchElementException - このコレクションが空の� �合

UnsupportedOperationException - このコレクション実装がこの操作をサポートしていない� �合

導入されたバージョン:

21

removeLast

default E removeLast()

このコレクションの最後の要� を削除して返します(オプションの操作)。

定義:

インタフェースSequencedCollection<E>内のremoveLast

定義:

インタフェースSortedSet<E>内のremoveLast

実装要件:

このセットが空でない� �合、このインタフェースの実装は、pollLastメソッドをコールした結果を返します。 それ以外の� �合は、NoSuchElementExceptionがスローされます。

戻り値:

削除される要�

スロー:

NoSuchElementException - このコレクションが空の� �合

UnsupportedOperationException - このコレクション実装がこの操作をサポートしていない� �合

導入されたバージョン:

21

reversed

default NavigableSet<E> reversed()

このコレクションの逆� �viewを返します。 返されるビュー内の要� の出現� �序は、このコレクション内の要� の出現� �序の逆です。 逆の� �序付けは、返されるビューのビュー・コレクションに含まれるすべての� �序依存操作に影響します。 コレクション実装でこのビューの変更が許可されている� �合、ベースとなるコレクションへの変更"ライトスルー"。 実装によっては、基礎となるコレクションに対する変更が、この逆方向ビューに表示される� �合と表示されない� �合があります。

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

定義:

インタフェースSequencedCollection<E>内のreversed

定義:

インタフェースSequencedSet<E>内のreversed

定義:

インタフェースSortedSet<E>内のreversed

実装要件:

このインタフェースの実装は、descendingSetメソッドをコールした結果を返します。

戻り値:

このコレクションの逆� �ビュー(NavigableSetとして)

導入されたバージョン:

21