文字列の末尾(\Z, \z)

文字列の末尾の位置にマッチするパターンを記述するにはメタ文字の1つである"\Z"を使います。

書式は次の通りです。

"パターン\Z"
"パターン\z"

パターンには"\Z"又は"\z"を除いたパターンを記述します。

"$"が行の末尾にマッチしたのに対して"\Z"及び"\z"は文字列の末尾にマッチします。その為、ターゲット文字列の中に行末文字が含まれていてもいなくても、常に文字列の行末位置にだけマッチします。

なお\Z"と"\z"の違いは、"\Z"は文字列の末尾が行末文字であった場合に行末文字を除いた後の行末にマッチします。"\z"の場合は文字列の最後が行末文字であっても無くても関係なく文字列の末尾にマッチします。

具体的な例で考えてみます。"abc def"と"def abc"と言う2つの文字列に対してパターンを"abc"と指定した場合にはどちらの文字列にも"abc"は含まれているため、どちらもマッチします。

○ abc def
○ def abc

これに対してパターンを"abc\z"と記述した場合は、文の末尾に位置に"abc"がある場合だけマッチします。よって"abc def"にはマッチしませんが"def abc"にはマッチします。また文の最後に行末文字がある場合も特別な扱いはしないためマッチしません。

× abc def
○ def abc
× def abc\n

なおパターンを"abc\Z"と記述した場合は、文の末尾に行末文字があった場合には行末文字を除いた後の行末にマッチします。よって"def abc"にもマッチしますし"def abc\n"にもマッチします。

× abc def
○ def abc
○ def abc\n

具体的には次のように記述します。

String str = "abcdef";
String regex = "abc\\Z";
Pattern p = Pattern.compile(regex);
Matcher m = p.matcher(str);

if (m.find()){
  System.out.println("マッチしました");
}else{
  System.out.println("マッチしません");
}

上記の場合はマッチしません。

どの文字が行末文字として扱われるのかは「行末文字」を参照して下さい。

サンプルプログラム

では実際に試してみます。

JSample4_1.java

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

class JSample4_1{
  public static void main(String args[]){
    String str1 = "abc def";
    String str2 = "def abc";
    String str3 = "abc\ndef";
    String str4 = "def abc\n";

    String regex1 = "abc\\Z";
    Pattern p1 = Pattern.compile(regex1);

    String regex2 = "abc\\z";
    Pattern p2 = Pattern.compile(regex2);

    System.out.println("パターン : " + regex1);

    check(p1, str1);
    check(p1, str2);
    check(p1, str3);
    check(p1, str4);

    System.out.println("パターン : " + regex2);

    check(p2, str1);
    check(p2, str2);
    check(p2, str3);
    check(p2, str4);
  }

  private static void check(Pattern p, String target){
    Matcher m = p.matcher(target);

    if (m.find()){
      System.out.println("○ " + target);
    }else{
      System.out.println("× " + target);
    }
  }
}

ではコンパイルを行った上で実行してみます。

文の最後に行末文字がある場合に、"\Z"と"\z"は異なる結果となります。