AndroidのPriorityBlockingQueueでpoll()メソッドを使う方法【サンプルコード付き】

PriorityBlockingQueueとは？

具体的な例に入る前に、PriorityBlockingQueueについて理解しておきましょう。PriorityBlockingQueueは境界なし（unbounded）のブロッキングキューであり、優先度キューと同じ順序ルールに従います。つまり、要素は自然順序付けまたは指定されたComparatorに基づいて並べられます。

このキューの主な利点は、マルチスレッド環境での安全な操作が可能な点です。また、容量制限がないため、メモリ不足（OutOfMemoryError）への対策としても活用されます。

本記事では、AndroidのPriorityBlockingQueueでpoll()メソッドを使う方法をサンプル付きで解説します。poll()メソッドは、キューの先頭にある（最も優先度の高い）要素を取得して削除します。キューが空の場合にはnullを返すのが特徴です。

実装手順

ステップ1：新規プロジェクトを作成する

Android Studioで新しいプロジェクトを作成します。メニューから「File」⇒「New Project」を選択し、必要な情報をすべて入力してプロジェクトを作成してください。

ステップ2：レイアウトファイルを編集する

res/layout/activity_main.xml に以下のコードを追加します。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:app="https://schemas.android.com/apk/res-auto"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:gravity="center"
    android:layout_height="match_parent"
    tools:context=".MainActivity"
    android:orientation="vertical">
    <TextView
        android:id="@+id/actionEvent"
        android:textSize="40sp"
        android:layout_marginTop="30dp"
        android:layout_width="wrap_content"
        android:layout_height="match_parent" />
</LinearLayout>

上記のコードでは、PriorityBlockingQueueの要素を表示するためのTextViewを配置しています。

ステップ3：MainActivity.javaを実装する

src/MainActivity.java に以下のコードを追加します。

package com.example.myapplication;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.RequiresApi;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.TextView;
import java.util.concurrent.PriorityBlockingQueue;
public class MainActivity extends AppCompatActivity {
    PriorityBlockingQueue priorityBlockingQueue;
    @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        priorityBlockingQueue = new PriorityBlockingQueue();
        final TextView actionEvent = findViewById(R.id.actionEvent);
        priorityBlockingQueue.add("sai");
        priorityBlockingQueue.add("ram");
        priorityBlockingQueue.add("krishna");
        priorityBlockingQueue.add("prasad");
        priorityBlockingQueue.add("ram");
        actionEvent.setText("" + priorityBlockingQueue);
        actionEvent.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                actionEvent.setText("" + priorityBlockingQueue.poll());
            }
        });
    }
}

このコードでは、まず5つの文字列要素をキューに追加しています。TextViewには初期状態でキューの中身全体が表示され、タップするとpoll()メソッドによって先頭の要素が取り出され、その値が画面に表示されます。

アプリの実行方法

それではアプリを実行してみましょう。実際のAndroid端末をパソコンに接続していることを前提とします。Android Studioからアプリを実行するには、プロジェクト内のいずれかのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。実行デバイスとしてお使いのスマートフォンを選択すると、端末に以下のような初期画面が表示されます。

次に、TextViewをタップしてみてください。poll()メソッドの実行結果として、以下のようにキューの先頭要素が表示されます。

まとめ

PriorityBlockingQueueのpoll()メソッドを使えば、マルチスレッド環境でも安全に、優先度に基づいて要素を取り出すことができます。キューが空の場合に例外ではなくnullを返す点がtake()メソッドとの大きな違いなので、用途に応じて使い分けるとよいでしょう。