【Java】Stream APIのallMatchメソッドについて解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 JavaのStream APIのallMatchメソッドについて

Stream APIのallMatchメソッドとは
Stream APIのallMatchメソッドを使ったサンプルプログラム

と、丁寧に解説していきます。

Stream APIについては、こちらの記事をご参考ください。

【Java】Stream APIについて解説します

前提条件：実行環境について
Stream APIのallMatchメソッドとは
Stream APIのallMatchメソッドを解説するプログラムの概要
Javaサンプルプログラム
実行結果
まとめ：Stream APIのallMatchメソッドを使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
IntelliJ IDEAのエディション	Community(無料版)
IntelliJ IDEAのバージョン	2021.3.2
プロジェクト	Javaプロジェクト
SDK	Oracle OpenJDK version17.0.2

Javaを動かすためにIntelliJ IDEAを使っています。
IntelliJ IDEAのインストールは、下の記事をご参考ください。

【IntelliJ IDEA】インストールするやり方を解説します（Windows向け）

Stream APIのallMatchメソッドとは

Stream APIのallMatchメソッドとは、ストリームのすべての要素が指定した条件に合致するかをboolean型で返すメソッドです。
すべて合致した場合のみtrue、合致しなかった場合はfalseを返します。
allMatchメソッドは、終端操作です。
使い方サンプルは以下になります。

boolean 【変数】 = 【Stream】
        .【中間操作】
        .allMatch(【引数】 -> 【条件式】);

boolean 【変数】 = 【Stream】

.【中間操作】

.allMatch(【引数】 -> 【条件式】);

注意点としてStreamが空だった場合、trueを返します。

では、次の章で実際に使ってみます。

Stream APIのallMatchメソッドを解説するプログラムの概要

Stream APIのallMatchメソッドを解説するプログラムでは、与えるStreamの判定結果が

trueの場合
falseの場合
Streamが空の場合

の3パターンでallMatchメソッドを使って全要素を判定し結果を表示して確認します。

解説で使うJavaプログラムは、Sampleプロジェクトのsampleパッケージ内にある、とします。
JavaのStream APIのallMatchメソッドを解説

Javaサンプルプログラム

package sample;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.stream.IntStream;
import java.util.stream.Stream;

public class Sample {
    public static void main(String[] args) {
        System.out.println("■allMatchメソッドサンプルプログラム");

        System.out.println("・すべて3文字以上か判定（trueの場合）");
        ArrayList<String> fruitList = new ArrayList(Arrays.asList("apple", "kiwi fruit", "strawberry", "orange"));
        boolean resultTrue = fruitList.stream()
                .allMatch(fruit -> fruit.length() >= 3);
        System.out.println("結果：" + resultTrue);

        System.out.println("・偶数のみであるか判定（falseの場合）");
        boolean resultFalse = IntStream.range(1, 6)
                .allMatch(i -> i % 2 == 0);
        System.out.println("結果：" + resultFalse);

        System.out.println("・空のストリームを判定");
        Stream<String> emptyStream = Stream.empty();
        boolean resultEmpty = emptyStream
                .allMatch(str -> str.length() > 3);
        System.out.println("結果：" + resultEmpty);
    }
}

package sample;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.stream.IntStream;

import java.util.stream.Stream;

public class Sample {

public static void main(String[] args) {

System.out.println("■allMatchメソッドサンプルプログラム");

System.out.println("・すべて3文字以上か判定（trueの場合）");

ArrayList<String> fruitList = new ArrayList(Arrays.asList("apple", "kiwi fruit", "strawberry", "orange"));

boolean resultTrue = fruitList.stream()

.allMatch(fruit -> fruit.length() >= 3);

System.out.println("結果：" + resultTrue);

System.out.println("・偶数のみであるか判定（falseの場合）");

boolean resultFalse = IntStream.range(1, 6)

.allMatch(i -> i % 2 == 0);

System.out.println("結果：" + resultFalse);

System.out.println("・空のストリームを判定");

Stream<String> emptyStream = Stream.empty();

boolean resultEmpty = emptyStream

.allMatch(str -> str.length() > 3);

System.out.println("結果：" + resultEmpty);

}

サンプルプログラムで使っている

IntStream.rangeメソッド
Arrays.asListメソッド
String.lengthメソッド

は詳しくはこちらの記事をご参考ください。

IntStream.rangeメソッド
【Java】Stream APIのIntStream.rangeメソッドについて解説します

Arrays.asListメソッド
【Java】配列をList型に変換できるArrays.asListメソッドを解説します

String.lengthメソッド
【Java】文字列の長さを取得できるString.lengthメソッドについて解説します

実行結果

Javaプログラムを実行します。
実行のやり方は

プログラムを右クリックして実行
実行タブから実行
ガターから実行

の3種類あるので、いずれかで実行します。
詳しい解説は以下の記事をご参考ください。

【IntelliJ IDEA】引数なしでJavaアプリケーションを実行するやり方を解説します

JavaのStream APIのallMatchメソッドを解説

■allMatchメソッドサンプルプログラム
・すべて3文字以上か判定（trueの場合）
結果：true
・偶数のみであるか判定（falseの場合）
結果：false
・空のストリームを判定
結果：true

■allMatchメソッドサンプルプログラム

・すべて3文字以上か判定（trueの場合）

結果：true

・偶数のみであるか判定（falseの場合）

結果：false

・空のストリームを判定

結果：true

allMatchメソッドですべての要素が条件に合致するときのみまたは空であるときにtrue、合致していないときはfalseを返していることが確認できました。

まとめ：Stream APIのallMatchメソッドを使ってみよう！

以上がJavaのStream APIのallMatchメソッドについての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ

【Java】Stream APIのanyMatchメソッドについて解説します