AndroidのLinkedBlockingDequeでofferFirst()を使う方法を徹底解説

LinkedBlockingDequeとは？

サンプルコードに入る前に、まずLinkedBlockingDequeの基本をおさえておきましょう。LinkedBlockingDequeは、CollectionインターフェースやAbstractQueueクラスをもとに実装されたクラスで、連結ノード（リンクリスト構造）に基づいて動作し、必要に応じて容量の上限（境界）を設定できる両端キュー（Deque）です。

コンストラクタにメモリサイズ（最大容量）を渡すことで、無駄なメモリ消費を防ぐことができ、Androidアプリ開発における効率的なメモリ管理に役立ちます。

この記事では、AndroidのLinkedBlockingDequeでofferFirst()メソッドを使用する方法を、実際のコード例とともにわかりやすく解説します。

offerFirst()メソッドのポイント

offerFirst()は、キューの先頭に要素を挿入するためのメソッドです。addFirst()と似ていますが、容量制限のあるキューで挿入に失敗した場合も例外をスローせずfalseを返す点が異なり、より安全に要素を追加したい場面で活用できます。

手順1：新規プロジェクトを作成する

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

手順2：activity_main.xmlにコードを追加する

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>

上記のコードでは、LinkedBlockingDequeの要素を画面に表示するための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.LinkedBlockingDeque;
public class MainActivity extends AppCompatActivity {
    LinkedBlockingDeque linkedBlockingDeque;
    @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        linkedBlockingDeque = new LinkedBlockingDeque();
        final TextView actionEvent = findViewById(R.id.actionEvent);
        linkedBlockingDeque.add("sai");
        linkedBlockingDeque.add("ram");
        linkedBlockingDeque.add("krishna");
        linkedBlockingDeque.add("prasad");
        linkedBlockingDeque.add("ram");
        actionEvent.setText("" + linkedBlockingDeque);
        actionEvent.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                linkedBlockingDeque.offerFirst("tutorialspoint");
                actionEvent.setText(""+linkedBlockingDeque);
            }
        });
    }
}

上記のコードでは、最初にadd()で複数の文字列をキューに追加し、TextViewにその内容を表示しています。そしてTextViewがタップされると、offerFirst()によってキューの先頭に新しい要素が挿入され、結果が再び画面に反映されます。

※ 新しいバージョンのAndroid Studioでは、android.support系のインポート文はAndroidX（例：androidx.appcompat.app.AppCompatActivity）へ自動的に置き換えられます。

アプリを実行して結果を確認する

それではアプリを実行してみましょう。実機のAndroidスマートフォンがパソコンに接続されているものとして進めます。Android Studioでプロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。表示される候補から自分のモバイルデバイスを選択すると、端末の初期画面には次のように表示されます。

続いて画面上のTextViewをタップすると、offerFirst()によりキューの先頭に要素が追加され、次のような結果が表示されます。

まとめ

LinkedBlockingDequeのofferFirst()を使えば、容量制限の有無にかかわらず、例外を発生させることなくキューの先頭へ安全に要素を追加できます。スレッドセーフな両端キュューとしてマルチスレッド環境でも活用できるので、ぜひ実際のプロジェクトでも試してみてください。