モジュール java.base
パッケージ java.util

クラスArrayDeque<E>

  • 型パラメータ:
    E - この両端キューに保持されている要素の型
    すべての実装されたインタフェース:
    Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, Queue<E>
    public class ArrayDeque<E>
extends AbstractCollection<E>
implements Deque<E>, Cloneable, Serializable
    Dequeインタフェースのサイズ変更可能な配列の実装です。 配列の両端キューに容量制限はなく、使用量をサポートするために必要に応じて大きくなります。 それらはスレッドセーフではありません。外部の同期化がない場合、複数のスレッドによる並行アクセスはサポートされません。 null要素は禁止されています。 このクラスは通常、スタックとして使われるときはStackよりも高速で、キューとして使われるときはLinkedListよりも高速です。

    ほとんどのArrayDequeオペレーションは、償却定数時間で実行されます。 例外には、remove、removeFirstOccurrence、removeLastOccurrence、contains、iterator.remove()、および一括オペレーションがあり、これらはすべて要素の数に比例する時間で実行されます。

    このクラスiteratorメソッドによって返されるイテレータは、fail-fastです: イテレータが作成された後、イテレータ自身のremoveメソッド以外の方法でイテレータが変更されると、イテレータは通常ConcurrentModificationExceptionをスローします。 このように、並行して変更が行われると、イテレータは、将来の予測できない時点において予測できない動作が発生する危険を回避するために、ただちにかつ手際よく例外をスローします。

    通常、非同期の並行変更がある場合、確かな保証を行うことは不可能なので、イテレータのフェイルファストの動作を保証することはできません。 フェイルファスト・イテレータは、ベスト・エフォート・ベースでConcurrentModificationExceptionをスローします。 したがって、正確を期すためにこの例外に依存するプログラムを書くことは誤りです。イテレータのフェイルファストの動作はバグを検出するためにのみ使用すべきです。

    このクラスとそのイテレータは、CollectionおよびIteratorインタフェースのオプション・メソッドすべてを実装します。

    このクラスは、Java Collections Frameworkのメンバーです。

    導入されたバージョン:
    1.6
    関連項目:
    直列化された形式

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      ArrayDeque()
      16個の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。
      ArrayDeque​(int numElements)
      指定された数の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。
      ArrayDeque​(Collection<? extends E> c)
      指定されたコレクションのイテレータが返す順序で、その要素を格納する両端キューを作成します。

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      boolean add​(E e)
      指定された要素をこの両端キューの末尾に挿入します。
      boolean addAll​(Collection<? extends E> c)
      指定されたコレクション内のすべての要素を、この両端キューの最後に、コレクション・イテレータによって返される順序で、それぞれaddLast(E)を呼び出すかのように追加します。
      void addFirst​(E e)
      指定された要素をこの両端キューの先頭に挿入します。
      void addLast​(E e)
      指定された要素をこの両端キューの末尾に挿入します。
      void clear()
      すべての要素を両端キューから削除します。
      ArrayDeque<E> clone()
      この両端キューの複製を返します。
      boolean contains​(Object o)
      指定された要素がこの両端キューに含まれている場合にtrueを返します。
      E element()
      この両端キューで表されるキューの先頭を取得しますが、削除しません。
      void forEach​(Consumer<? super E> action)
      Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。
      E getFirst()
      この両端キューの最初の要素を取得しますが、削除はしません。
      E getLast()
      この両端キューの最後の要素を取得しますが、削除はしません。
      boolean isEmpty()
      この両端キューに要素が含まれていない場合にtrueを返します。
      Iterator<E> iterator()
      両端キューの要素のイテレータを返します。
      boolean offer​(E e)
      指定された要素をこの両端キューの末尾に挿入します。
      boolean offerFirst​(E e)
      指定された要素をこの両端キューの先頭に挿入します。
      boolean offerLast​(E e)
      指定された要素をこの両端キューの末尾に挿入します。
      E peek()
      この両端キューによって表されるキューの先頭を取得しますが、削除しません。両端キューが空の場合はnullを返します。
      E poll()
      この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得および削除します。両端キューが空の場合は、nullを返します。
      E pop()
      この両端キューで表されるスタックに要素をポップします。
      void push​(E e)
      この両端キューで表されるスタックに要素を入れます。
      E remove()
      この両端キューが表すキューの先頭を取得して削除します。
      boolean remove​(Object o)
      指定された要素の単一のインスタンスを、この両端キューから削除します。
      boolean removeAll​(Collection<?> c)
      指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。
      E removeFirst()
      この両端キューの最初の要素を取得して削除します。
      boolean removeFirstOccurrence​(Object o)
      両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最初に出現したものを削除します。
      boolean removeIf​(Predicate<? super E> filter)
      指定された述語を満たすこのコレクションの要素をすべて削除します。
      E removeLast()
      この両端キューの最後の要素を取得して削除します。
      boolean removeLastOccurrence​(Object o)
      両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最後に出現したものを削除します。
      boolean retainAll​(Collection<?> c)
      このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。
      int size()
      この両端キュー内の要素の数を返します。
      Spliterator<E> spliterator()
      この両端キュー内の要素に対する遅延バインディングおよびフェイルファスト Spliteratorを作成します。
      Object[] toArray()
      両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。
      <T> T[] toArray​(T[] a)
      両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。

    • コンストラクタの詳細

      • ArrayDeque

        public ArrayDeque()
        16個の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。

      • ArrayDeque

        public ArrayDeque​(int numElements)
        指定された数の要素を保持するために十分な初期容量を持つ、空の配列両端キューを作成します。
        パラメータ:
        numElements - 両端キューの初期容量の範囲の下限

      • ArrayDeque

        public ArrayDeque​(Collection<? extends E> c)
        指定されたコレクションのイテレータが返す順序で、その要素を格納する両端キューを作成します。 コレクションのイテレータによって返される最初の要素が、最初の要素、つまり両端キューの先頭になります。
        パラメータ:
        c - 要素が両端キューに配置されるコレクション
        例外:
        NullPointerException - 指定されたコレクションがnullである場合

    • メソッドの詳細

      • addFirst

        public void addFirst​(E e)
        指定された要素をこの両端キューの先頭に挿入します。
        定義:
        addFirst、インタフェース: Deque<E>
        パラメータ:
        e - 追加する要素
        例外:
        NullPointerException - 指定された要素がnullである場合

      • addLast

        public void addLast​(E e)
        指定された要素をこの両端キューの末尾に挿入します。

        このメソッドは、add(E)と同等です。

        定義:
        addLast、インタフェース: Deque<E>
        パラメータ:
        e - 追加する要素
        例外:
        NullPointerException - 指定された要素がnullである場合

      • addAll

        public boolean addAll​(Collection<? extends E> c)
        指定されたコレクション内のすべての要素を、この両端キューの最後に、コレクション・イテレータによって返される順序で、それぞれaddLast(E)を呼び出すかのように追加します。
        定義:
        addAll、インタフェース: Collection<E>
        定義:
        インタフェースDeque<E>内のaddAll
        オーバーライド:
        addAll、クラス: AbstractCollection<E>
        パラメータ:
        c - この両端キューに挿入される要素
        戻り値:
        この呼出しの結果、この両端キューが変更された場合はtrue
        例外:
        NullPointerException - 指定されたコレクションまたはそのいずれかの要素がnullである場合
        関連項目:
        AbstractCollection.add(Object)

      • offerFirst

        public boolean offerFirst​(E e)
        指定された要素をこの両端キューの先頭に挿入します。
        定義:
        offerFirst、インタフェース: Deque<E>
        パラメータ:
        e - 追加する要素
        戻り値:
        true (Deque.offerFirst(E)で指定されているとおり)
        例外:
        NullPointerException - 指定された要素がnullである場合

      • offerLast

        public boolean offerLast​(E e)
        指定された要素をこの両端キューの末尾に挿入します。
        定義:
        offerLast、インタフェース: Deque<E>
        パラメータ:
        e - 追加する要素
        戻り値:
        true (Deque.offerLast(E)で指定されているとおり)
        例外:
        NullPointerException - 指定された要素がnullである場合

      • removeFirst

        public E removeFirst()
        インタフェースからコピーされた説明: Deque
        この両端キューの最初の要素を取得して削除します。 このメソッドは、両端キューが空の場合に例外をスローする点のみがpollFirstメソッドと異なります。
        定義:
        removeFirst、インタフェース: Deque<E>
        戻り値:
        この両端キューの先頭
        例外:
        NoSuchElementException - この両端キューが空の場合

      • removeLast

        public E removeLast()
        インタフェースからコピーされた説明: Deque
        この両端キューの最後の要素を取得して削除します。 このメソッドは、両端キューが空の場合に例外をスローする点のみがpollLastメソッドと異なります。
        定義:
        removeLast、インタフェース: Deque<E>
        戻り値:
        この両端キューの末尾
        例外:
        NoSuchElementException - この両端キューが空の場合

      • getFirst

        public E getFirst()
        インタフェースからコピーされた説明: Deque
        この両端キューの最初の要素を取得しますが、削除はしません。 このメソッドは、両端キューが空の場合に例外をスローする点のみがpeekFirstメソッドと異なります。
        定義:
        getFirst、インタフェース: Deque<E>
        戻り値:
        この両端キューの先頭
        例外:
        NoSuchElementException - この両端キューが空の場合

      • getLast

        public E getLast()
        インタフェースからコピーされた説明: Deque
        この両端キューの最後の要素を取得しますが、削除はしません。 このメソッドは、両端キューが空の場合に例外をスローする点のみがpeekLastメソッドと異なります。
        定義:
        getLast、インタフェース: Deque<E>
        戻り値:
        この両端キューの末尾
        例外:
        NoSuchElementException - この両端キューが空の場合

      • removeFirstOccurrence

        public boolean removeFirstOccurrence​(Object o)
        両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最初に出現したものを削除します。 その要素が両端キューにない場合、変更はありません。 つまり、o.equals(e)となる最初の要素eが存在する場合は、その要素を削除します。 指定された要素がこの両端キューに含まれていた場合(すなわち、呼出しの結果としてこの両端キューが変更された場合)はtrueを返します。
        定義:
        removeFirstOccurrence、インタフェース: Deque<E>
        パラメータ:
        o - この両端キューから削除される要素(その要素が存在する場合)
        戻り値:
        指定された要素がこの両端キューに含まれていた場合はtrue

      • removeLastOccurrence

        public boolean removeLastOccurrence​(Object o)
        両端キューを先頭から末尾までトラバースするときに、この両端キューの指定された要素のうち最後に出現したものを削除します。 その要素が両端キューにない場合、変更はありません。 つまり、o.equals(e)となる最後の要素eが存在する場合は、その要素を削除します。 指定された要素がこの両端キューに含まれていた場合(すなわち、呼出しの結果としてこの両端キューが変更された場合)はtrueを返します。
        定義:
        removeLastOccurrence、インタフェース: Deque<E>
        パラメータ:
        o - この両端キューから削除される要素(その要素が存在する場合)
        戻り値:
        指定された要素がこの両端キューに含まれていた場合はtrue

      • add

        public boolean add​(E e)
        指定された要素をこの両端キューの末尾に挿入します。

        このメソッドは、addLast(E)と同等です。

        定義:
        add、インタフェース: Collection<E>
        定義:
        add、インタフェース: Deque<E>
        定義:
        add、インタフェース: Queue<E>
        オーバーライド:
        add、クラス: AbstractCollection<E>
        パラメータ:
        e - 追加する要素
        戻り値:
        true (Collection.add(E)で指定されているとおり)
        例外:
        NullPointerException - 指定された要素がnullである場合

      • offer

        public boolean offer​(E e)
        指定された要素をこの両端キューの末尾に挿入します。

        このメソッドは、offerLast(E)と同等です。

        定義:
        offer、インタフェース: Deque<E>
        定義:
        offer、インタフェース: Queue<E>
        パラメータ:
        e - 追加する要素
        戻り値:
        true (Queue.offer(E)で指定されているとおり)
        例外:
        NullPointerException - 指定された要素がnullである場合

      • remove

        public E remove()
        この両端キューが表すキューの先頭を取得して削除します。 このメソッドは、両端キューが空の場合に例外をスローする点のみがpoll()メソッドと異なります。

        このメソッドは、removeFirst()と同等です。

        定義:
        remove、インタフェース: Deque<E>
        定義:
        remove、インタフェース: Queue<E>
        戻り値:
        この両端キューで表されるキューの先頭
        例外:
        NoSuchElementException - この両端キューが空の場合

      • poll

        public E poll()
        この両端キューによって表されるキューの先頭(つまり、この両端キューの最初の要素)を取得および削除します。両端キューが空の場合は、nullを返します。

        このメソッドは、Deque.pollFirst()と同等です。

        定義:
        poll、インタフェース: Deque<E>
        定義:
        poll、インタフェース: Queue<E>
        戻り値:
        この両端キューで表されるキューの先頭。この両端キューが空の場合はnull

      • element

        public E element()
        この両端キューで表されるキューの先頭を取得しますが、削除しません。 このメソッドは、両端キューが空の場合に例外をスローする点のみがpeekメソッドと異なります。

        このメソッドは、getFirst()と同等です。

        定義:
        element、インタフェース: Deque<E>
        定義:
        element、インタフェース: Queue<E>
        戻り値:
        この両端キューで表されるキューの先頭
        例外:
        NoSuchElementException - この両端キューが空の場合

      • peek

        public E peek()
        この両端キューによって表されるキューの先頭を取得しますが、削除しません。両端キューが空の場合はnullを返します。

        このメソッドは、Deque.peekFirst()と同等です。

        定義:
        peek、インタフェース: Deque<E>
        定義:
        peek、インタフェース: Queue<E>
        戻り値:
        この両端キューで表されるキューの先頭。この両端キューが空の場合はnull

      • push

        public void push​(E e)
        この両端キューで表されるスタックに要素を入れます。 つまり、要素をこの両端キューの先頭に挿入します。

        このメソッドは、addFirst(E)と同等です。

        定義:
        push、インタフェース: Deque<E>
        パラメータ:
        e - プッシュする要素
        例外:
        NullPointerException - 指定された要素がnullである場合

      • pop

        public E pop()
        この両端キューで表されるスタックに要素をポップします。 つまり、この両端キューの最初の要素を削除して返します。

        このメソッドは、removeFirst()と同等です。

        定義:
        pop、インタフェース: Deque<E>
        戻り値:
        この両端キューの先頭の要素(この両端キューによって表されるスタックの上部)
        例外:
        NoSuchElementException - この両端キューが空の場合

      • size

        public int size()
        この両端キュー内の要素の数を返します。
        定義:
        size、インタフェース: Collection<E>
        定義:
        size、インタフェース: Deque<E>
        戻り値:
        この両端キュー内の要素の数

      • isEmpty

        public boolean isEmpty()
        この両端キューに要素が含まれていない場合にtrueを返します。
        定義:
        isEmpty、インタフェース: Collection<E>
        オーバーライド:
        isEmpty、クラス: AbstractCollection<E>
        戻り値:
        この両端キューに要素が含まれていない場合はtrue

      • iterator

        public Iterator<E> iterator()
        両端キューの要素のイテレータを返します。 要素の順序は最初(先頭)から最後(末尾)になります。 これは、要素がremove()の連続する呼出しによってキューから取り出される順序、またはpop()の連続する呼出しによってポップされる順序と同じです。
        定義:
        iterator、インタフェース: Collection<E>
        定義:
        iterator、インタフェース: Deque<E>
        定義:
        iterator、インタフェース: Iterable<E>
        定義:
        iterator、クラス: AbstractCollection<E>
        戻り値:
        両端キューの要素のイテレータ

      • forEach

        public void forEach​(Consumer<? super E> action)
        インタフェースからコピーされた説明: Iterable
        Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。 反復の順序でアクションが実行されます(その順序が指定されている場合)。 アクションによってスローされた例外は、呼出し側に中継されます。

        オーバーライドするクラスが並行変更ポリシーを指定していない限り、アクションが要素の基本ソースを変更する副作用を実行する場合、このメソッドの動作は指定されていません。

        定義:
        forEach、インタフェース: Iterable<E>
        パラメータ:
        action - 各要素に対して実行されるアクション
        例外:
        NullPointerException - 指定されたアクションがnullである場合

      • removeIf

        public boolean removeIf​(Predicate<? super E> filter)
        次のインタフェースからコピーされた説明: Collection
        指定された述語を満たすこのコレクションの要素をすべて削除します。 反復中に、または述語によってスローされたエラーまたは実行時例外は、呼出し側に中継されます。
        定義:
        removeIf、インタフェース: Collection<E>
        パラメータ:
        filter - 削除される要素に対してtrueを返す述語
        戻り値:
        要素が削除された場合はtrue
        例外:
        NullPointerException - 指定されたフィルタがnullである場合

      • removeAll

        public boolean removeAll​(Collection<?> c)
        次のクラスからコピーされた説明: AbstractCollection
        指定されたコレクションにも格納されているこのコレクションのすべての要素を削除します(オプションの操作)。 この呼出しの結果、このコレクションには指定されたコレクションと共通の要素はなくなります。
        定義:
        removeAll、インタフェース: Collection<E>
        オーバーライド:
        removeAll、クラス: AbstractCollection<E>
        パラメータ:
        c - このコレクションから削除される要素を含むコレクション
        戻り値:
        呼出しの結果としてこのコレクションが変更された場合はtrue
        例外:
        NullPointerException - このコレクションに1つ以上のnull要素が含まれており、指定されたコレクションがnull要素をサポートしない場合(オプション)、または指定されたコレクションがnullの場合
        関連項目:
        AbstractCollection.remove(Object), AbstractCollection.contains(Object)

      • retainAll

        public boolean retainAll​(Collection<?> c)
        次のクラスからコピーされた説明: AbstractCollection
        このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します(オプションの操作)。 つまり、指定されたコレクションに格納されていないすべての要素をこのコレクションから削除します。
        定義:
        retainAll、インタフェース: Collection<E>
        オーバーライド:
        retainAll、クラス: AbstractCollection<E>
        パラメータ:
        c - このコレクションで保持される要素を含むコレクション
        戻り値:
        呼出しの結果としてこのコレクションが変更された場合はtrue
        例外:
        NullPointerException - このコレクションに1つ以上のnull要素が含まれており、指定されたコレクションがnull要素を許可しない場合(オプション)、または指定されたコレクションがnullの場合
        関連項目:
        AbstractCollection.remove(Object), AbstractCollection.contains(Object)

      • contains

        public boolean contains​(Object o)
        指定された要素がこの両端キューに含まれている場合にtrueを返します。 つまり、この両端キューに、o.equals(e)となる要素eが1つ以上含まれている場合にだけtrueを返します。
        定義:
        contains、インタフェース: Collection<E>
        定義:
        contains、インタフェース: Deque<E>
        オーバーライド:
        contains、クラス: AbstractCollection<E>
        パラメータ:
        o - この両端キューに含まれているかどうかを調べるオブジェクト
        戻り値:
        指定された要素がこの両端キューに含まれている場合はtrue

      • remove

        public boolean remove​(Object o)
        指定された要素の単一のインスタンスを、この両端キューから削除します。 その要素が両端キューにない場合、変更はありません。 つまり、o.equals(e)となる最初の要素eが存在する場合は、その要素を削除します。 指定された要素がこの両端キューに含まれていた場合(すなわち、呼出しの結果としてこの両端キューが変更された場合)はtrueを返します。

        このメソッドは、removeFirstOccurrence(Object)と同等です。

        定義:
        remove、インタフェース: Collection<E>
        定義:
        remove、インタフェース: Deque<E>
        オーバーライド:
        remove、クラス: AbstractCollection<E>
        パラメータ:
        o - この両端キューから削除される要素(その要素が存在する場合)
        戻り値:
        指定された要素がこの両端キューに含まれていた場合はtrue

      • clear

        public void clear()
        すべての要素を両端キューから削除します。 この呼出しが戻ると、両端キューは空になります。
        定義:
        clear、インタフェース: Collection<E>
        オーバーライド:
        clear、クラス: AbstractCollection<E>

      • toArray

        public Object[] toArray()
        両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。

        返される配列への参照を両端キューが維持しないという点で、この配列は安全です。 (つまり、このメソッドは新しい配列を割り当てます。) このため、呼出し側は、返された配列を自由に変更できます。

        このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。

        定義:
        toArray、インタフェース: Collection<E>
        オーバーライド:
        toArray、クラス: AbstractCollection<E>
        戻り値:
        両端キューのすべての要素が格納されている配列

      • toArray

        public <T> T[] toArray​(T[] a)
        両端キュー内のすべての要素を適切な順序(最初の要素から最後の要素へ)で格納している配列を返します。返される配列の実行時の型は、指定された配列の型になります。 指定された配列に両端キューが収まる場合は、その中に返されます。 そうでない場合は、指定された配列の実行時の型と両端キューのサイズを持つ新しい配列が割り当てられます。

        両端キューが指定された配列に収まり、その配列にさらに余裕がある場合(つまり、配列が両端キューより多くの要素を持つ場合)、その配列内で両端キューの終端よりあとの要素はnullに設定されます。

        toArray()メソッドと同じように、このメソッドは、配列ベースのAPIとコレクションベースのAPIの間の橋渡し役として機能します。 さらに、このメソッドでは出力配列の実行時の型を正確に制御できるため、環境によっては割当ての手間を抑えるために使用できます。

        xが、文字列だけからなる両端キューであることがわかっていると仮定します。 次のコードを使うと、新しく割り当てられたStringの配列に両端キューをダンプできます。 

         String[] y = x.toArray(new String[0]);
        toArray(new Object[0])は、機能の点でtoArray()と同一です。

        定義:
        toArray、インタフェース: Collection<E>
        オーバーライド:
        toArray、クラス: AbstractCollection<E>
        型パラメータ:
        T - コレクションを格納する配列のコンポーネント型
        パラメータ:
        a - 配列が十分な大きさを持つ場合は、両端キューの要素が格納される配列。そうでない場合は、要素を格納するために同じ実行時の型の新しい配列が割り当てられる
        戻り値:
        両端キューのすべての要素が格納されている配列
        例外:
        ArrayStoreException - 指定された配列の実行時の型が、この両端キュー内のすべての要素の実行時の型のスーパー・タイプでない場合
        NullPointerException - 指定された配列がnullである場合

      • clone

        public ArrayDeque<E> clone()
        この両端キューの複製を返します。
        オーバーライド:
        clone、クラス: Object
        戻り値:
        この両端キューのコピー
        関連項目:
        Cloneable