Java スタック(Stack)のサンプル(ArrayDequeクラス)

Javaのスタック(Stack)のサンプルです。
ArrayDequeクラスを使用します。

ArrayDequeクラス
Dequeインターフェース
要素を追加する (pushメソッド)
要素を取得してスタックから削除する (pollFirstメソッド)
要素を取得してスタックから削除する (popメソッド)
要素を取得してスタックから削除しない (peekメソッド)

ArrayDequeクラス

public class ArrayDeque<E> extends AbstractCollection<E>
implements Deque<E>, Cloneable, Serializable

スタックを実現します。
スタックとは、後に入れたデータが、先に取り出されることです。(下図参照)
「後入れ先出し」といいます。英語では LIFO(Last In First Out)です。
ArrayDequeクラスは、Java 6で導入されました。
各項目を要素(element)といいます。
以下はOracleのJava8 API仕様のArrayDequeクラスのリンクです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/ArrayDeque.html

Dequeインターフェース

public interface Deque<E> extends Queue<E>

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

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

public void push(E e)

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

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.push("赤");
        colors.push("黄");
        colors.push("青");
        
        for (String a : colors) {
            System.out.println(a);//青 黄 赤
        }
        
        colors.push("白");
        
        for (String a : colors) {
            System.out.println(a);//白 青 黄 赤 
        }
    }
 }

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

要素を取得してスタックから削除する (pollFirstメソッド)

public E pollFirst()

要素を取得してスタックから削除するサンプルです。

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.push("赤");
        colors.push("黄");
        
        String a = colors.pollFirst();
        System.out.println(a); //黄
        System.out.println(colors); //[赤]
        
        String b = colors.pollFirst();
        System.out.println(b); //赤
        System.out.println(colors); //[]
        
        String c = colors.pollFirst();
        System.out.println(c); //null
        System.out.println(colors); //[]
    }
 }

12～18行目は、pollFirstメソッドでスタックから要素を取得してスタックの要素を削除しています。
20行目は、要素がない変数に対してpollFirstメソッドを実行しています。
21行目は、nullになります。エラーになりません。

要素を取得してスタックから削除する (popメソッド)

public E pop()

要素を取得してスタックから削除するサンプルです。

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.push("赤");
        colors.push("黄");
        
        String a = colors.pop();
        System.out.println(a); //黄
        System.out.println(colors); //[赤]
        
        String b = colors.pop();
        System.out.println(b); //赤
        System.out.println(colors); //[]
        
        String c = colors.pop(); //例外が発生
//        System.out.println(c); //
//        System.out.println(colors); //
    }
 }

12～18行目は、popメソッドでスタックから要素を取得してスタックの要素を削除しています。
20行目は、要素がない変数に対してpopメソッドを実行しています。java.util.NoSuchElementExceptionの例外が発生が発生します。

要素を取得してスタックから削除しない (peekメソッド)

public E 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.push("赤");
        colors.push("黄");
        colors.push("青");
        
        String b = colors.peek();
        
        System.out.println(colors); //[青, 黄, 赤]
        
        System.out.println(b); //青
    }
 }

13行目は、最後に追加した要素"青"を取得して変数bにセットしています。pollFirstメソッドやpopメソッドと違い、変数colorsの要素は削除しません。