Java キュー(Queue)のサンプル(ArrayDequeクラス)

Javaのキュー(Queue)のサンプルです。
ArrayDequeクラスを使用します。

確認環境
・Java 8

ArrayDequeクラス
Dequeインターフェース
要素を追加する (addメソッド)
要素を取得してキューから削除する (pollメソッド)
要素を取得してキューから削除する (removeメソッド) -pollメソッドとの違い
要素を取得してキューから削除しない (peekメソッド)

ArrayDequeクラス

キューを実現します。
キューは、先に入れたデータが、先に取り出されます。(上図参照)
「先入れ先出し」といいます。英語では FIFO(First In First Out)です。
以下はJava8 API仕様のArrayDequeクラスのリンクです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/ArrayDeque.html

Dequeインターフェース

ArrayDequeクラスはDequeインターフェースを実装しています。
ArrayDequeクラスをインスタンス化する時、ArrayDequeクラスの独自のメソッドを使用しない限り、通常インターフェイス型の変数に代入します。
ArrayDequeクラスは、Dequeインターフェースを実装しているので、Dequeインターフェイスにあるメソッドを使用できます。
以下はJava8 API仕様のDequeインターフェースのリンクです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/Deque.html

要素を追加する (addメソッド)

要素を追加するサンプルです。

package test1;
import java.util.ArrayDeque;
import java.util.Deque;

public class Test1 {
    public static void main(String[] args) {
        
    	Deque<String> colors = new ArrayDeque<>();
        
        colors.add("赤");
        colors.add("黄");
        colors.add("青");
        
        for (String a : colors) {
            System.out.println(a);//赤 黄 青
        }
        
        colors.add("白");
        
        for (String a : colors) {
            System.out.println(a);//赤 黄 青 白
        }
    }
 }

8行目は、ArrayDequeクラスをインスタンス化してDequeインターフェイス型の変数に代入しています。ジェネリクス<>でオブジェクトの中身はStringであると宣言しています。
10-12行目は、addメソッドで要素を追加しています。
18行目は、要素を追加しています。
15,21行目は、先に入れたデータが、先に取り出されています。

要素を取得してキューから削除する (pollメソッド)

pollメソッドの要素を取得してキューから削除するサンプルです。

package test1;
import java.util.ArrayDeque;
import java.util.Deque;

public class Test1 {
    public static void main(String[] args) {
        
    	Deque<String> colors = new ArrayDeque<>();
        colors.add("赤");
        colors.add("黄");
        colors.add("青");
        
        String b = colors.poll();
        
        System.out.println(colors); //[黄, 青]
        
        System.out.println(b); //赤
    }
 }

13行目は、変数colorsの最初に追加した要素"赤"を取得して変数bにセットしています。変数colorsの要素"赤"は削除しています。

要素を取得してキューから削除する (removeメソッド) -pollメソッドとの違い

removeメソッドの要素を取得してキューから削除するサンプルです。

package test1;
import java.util.ArrayDeque;
import java.util.Deque;

public class Test1 {
    public static void main(String[] args) {
        
    	Deque<String> colors = new ArrayDeque<>();
        colors.add("赤");
        System.out.println(colors.poll()); //赤
        System.out.println(colors.poll()); //null
        
        colors.add("青");
        System.out.println(colors.remove()); //青
        System.out.println(colors.remove()); //例外が発生する
    }
 }

10,11行目は、pollメソッドです。要素を取得してキューから削除しています。
11行目の要素がない場合、pollメソッドはnullを返します。

14,15行目は、removeメソッドです。要素を取得してキューから削除しています。
15行目の要素がない場合、removeメソッドはjava.util.NoSuchElementExceptionの例外を返します。

要素を取得してキューから削除しない (peekメソッド)

要素を取得してキューから削除しないサンプルです。

package test1;
import java.util.ArrayDeque;
import java.util.Deque;

public class Test1 {
    public static void main(String[] args) {
        
    	Deque<String> colors = new ArrayDeque<>();
        colors.add("赤");
        colors.add("黄");
        colors.add("青");
        
        String b = colors.peek();
        
        System.out.println(colors); //[赤, 黄, 青]
        
        System.out.println(b); //赤
    }
 }

13行目は、変数colorsの最初に追加した要素"赤"を取得して変数bにセットしています。poll/removeメソッドと違い、変数colorsの要素は削除しません。