JavaのPatternクラスflags()メソッドとは？使い方をサンプルコード付きで解説

Patternクラスとは

java.util.regexパッケージのPatternクラスは、正規表現をコンパイルした結果を表すクラスです。あらかじめ正規表現をオブジェクトとして保持しておくことで、繰り返しのマッチング処理を高速かつ効率的に行えるようになります。

compile()メソッドのシグネチャ

このクラスのcompile()メソッドは、正規表現を表す文字列を受け取り、Patternオブジェクトを返します。基本的なシグネチャは以下のとおりです。

static Pattern compile(String regex)

また、このメソッドにはマッチングの動作を制御するための「フラグ」をint値として指定できるオーバーロード版も用意されています。

static Pattern compile(String regex, int flags)

Patternクラスが提供する主なフラグ一覧

flags()メソッドとは

flags()メソッドは、現在のPatternオブジェクトに設定されているフラグをint値として返します。どのフラグが有効になっているかを実行時に確認したい場合に役立ちます。

flags()メソッドの使用例

以下の例では、COMMENTSフラグを使ってコメント付きの正規表現をコンパイルし、生年月日（MM/DD/YYYY形式）の妥当性を検証しています。最後にflags()メソッドで設定済みのフラグを出力します。

import java.util.Scanner;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class COMMENTS_Example {
   public static void main(String[] args) {
      Scanner sc = new Scanner(System.in);
      System.out.println("Enter your name: ");
      String name = sc.nextLine();
      System.out.println("Enter your Date of birth: ");
      String dob = sc.nextLine();
      // MM/DD/YYYY形式の日付を受け付ける正規表現
      String regex = "^(1[0-2]|0[1-9])/ # For Month\n"
           + "(3[01]|[12][0-9]|0[1-9])/ # For Date\n"
           + "[0-9]{4}$ # For Year";
      // Patternオブジェクトの生成（COMMENTSフラグを指定）
      Pattern pattern = Pattern.compile(regex, Pattern.COMMENTS);
      // Matcherオブジェクトの生成
      Matcher matcher = pattern.matcher(dob);
      boolean result = matcher.matches();
      if(result) {
         System.out.println("Given date of birth is valid");
      } else {
         System.out.println("Given date of birth is not valid");
      }
      System.out.println("Flag used: "+ pattern.flags());
   }
}

実行結果

Enter your name:
Krishna
Enter your Date of birth:
09/26/1989
Given date of birth is valid
Flag used: 4

まとめ

実行結果の「Flag used: 4」は、COMMENTSフラグ（値は4）がパターンに設定されていることを示しています。このようにflags()メソッドを使えば、Patternオブジェクトに適用されたフラグを簡単に確認できます。複数のフラグを組み合わせる場合はビットごとのOR演算子（|）で指定でき、戻り値と照合することで有効なフラグを判定することも可能です。