AndroidのCopyOnWriteArraySetでretainAll()を使う方法【サンプルコード付き】

CopyOnWriteArraySetとは？

実装例に入る前に、まずCopyOnWriteArraySetについて簡単におさらいしておきましょう。CopyOnWriteArraySetはjava.util.concurrentパッケージに含まれるスレッドセーフなSetの実装で、addやsetなどの変更操作が行われるたびに、内部で保持している配列の新しいコピーを作成することでスレッドセーフ性を実現しています。

この仕組みにより、複数のスレッドから安全にアクセスできる反面、頻繁な書き込みにはコピーのコストがかかるため、読み取りが多く書き込みが少ない場面に適しています。

本記事では、そんなCopyOnWriteArraySetに対してretainAll()メソッドを使い、指定した要素だけを残す方法を、Androidのサンプルコード付きで解説します。retainAll()は、引数に渡したコレクションに含まれる要素のみを保持し、それ以外の要素をすべて削除するメソッドです。

実装手順

ステップ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>

上記のコードでは、CopyOnWriteArraySetの要素を画面に表示するためのTextViewを1つ配置しています。

ステップ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.Arrays;
import java.util.Collections;
import java.util.concurrent.CopyOnWriteArraySet;
public class MainActivity extends AppCompatActivity {
   CopyOnWriteArraySet copyOnWriteArraySet;
   String head;
   @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      copyOnWriteArraySet = new CopyOnWriteArraySet<String>();
      final TextView actionEvent = findViewById(R.id.actionEvent);
      copyOnWriteArraySet.add("sai");
      copyOnWriteArraySet.add("ram");
      copyOnWriteArraySet.add("krishna");
      copyOnWriteArraySet.add("prasad");
      copyOnWriteArraySet.add("ram");
      actionEvent.setText("" + copyOnWriteArraySet);
      actionEvent.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            String[] strings = {"krishna","ram"};
            copyOnWriteArraySet.retainAll(Arrays.asList(strings));
            actionEvent.setText(""+copyOnWriteArraySet);
         }
      });
   }
}

このコードでは、まずCopyOnWriteArraySetに複数の文字列を追加しています。なお、Setは重複を許さないため、2回追加した「ram」は1つだけ格納されます。その後、TextViewにクリックリスナーを設定し、タップされたタイミングでretainAll()を呼び出して「krishna」と「ram」以外の要素を削除しています。

アプリを実行して動作を確認する

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

初期状態では、CopyOnWriteArraySetに追加された「sai」「ram」「krishna」「prasad」が表示されています。

続いて、TextViewをタップしてみてください。retainAll()によって「krishna」と「ram」以外の要素が削除され、以下のように結果が表示されます。

まとめ

このように、CopyOnWriteArraySetでも通常のSetコレクションと同様にretainAll()メソッドを使用できます。スレッドセーフなコレクションでありながら、共通要素の抽出といった集合操作もシンプルなコードで実現できるのが魅力です。マルチスレッド環境で読み取りが多く、更新頻度が比較的低いデータを扱う際には、ぜひ活用してみてください。