PatternFlag.java

  1. package com.github.mygreen.supercsv.annotation;


  2. /**
  3.  * 正規表現をコンパイルする際のフラグを表現するための列挙型。
  4.  * <p>アノテーションの正規表現の属性として指定するために使用する。</p>
  5.  *
  6.  * @since 2.0
  7.  * @author T.TSUCHIE
  8.  *
  9.  */
  10. public enum PatternFlag {
  11.    
  12.     /**
  13.      * Unixライン・モードを有効にします。
  14.      * <p>このモードでは、「{@literal \n}」行末記号以外は、{@literal .、^、および$}の動作で認識されません。</p>
  15.      *
  16.      * @see java.util.regex.Pattern#UNIX_LINES
  17.      */
  18.     UNIX_LINES( java.util.regex.Pattern.UNIX_LINES ),
  19.    
  20.     /**
  21.      * 大文字と小文字を区別しないマッチングを有効にします。
  22.      * <p>デフォルトの大文字と小文字を区別しないマッチングでは、US-ASCII文字セットの文字だけがマッチします。
  23.      *    Unicodeに準拠した大文字と小文字を区別しないマッチングを有効にするには、
  24.      *    {@link #UNIX_LINES}フラグをこのフラグと組み合わせて指定します。
  25.      * </p>
  26.      *
  27.      * @see java.util.regex.Pattern#CASE_INSENSITIVE
  28.      */
  29.     CASE_INSENSITIVE( java.util.regex.Pattern.CASE_INSENSITIVE ),
  30.    
  31.     /**
  32.      * パターン内で空白とコメントを使用できるようにします。
  33.      * <p>このモードでは、空白は無視され、#で始まる埋込みコメントは行末まで無視されます。</p>
  34.      *
  35.      * @see java.util.regex.Pattern#COMMENTS
  36.      */
  37.     COMMENTS( java.util.regex.Pattern.COMMENTS ),
  38.    
  39.     /**
  40.      * 複数行モードを有効にします。
  41.      * <p>複数行モードでは、表現{@literal ^と$}は、それぞれ行末記号または入力シーケンスの末尾の直後または直前にマッチします。
  42.      *    デフォルトでは、これらの表現は入力シーケンス全体の先頭と末尾にだけマッチします。
  43.      * </p>
  44.      *
  45.      * @see java.util.regex.Pattern#MULTILINE
  46.      */
  47.     MULTILINE( java.util.regex.Pattern.MULTILINE ),
  48.    
  49.     /**
  50.      * DOTALLモードを有効にします。
  51.      * <p>DOTALLモードでは、表現.は行末記号を含む任意の文字にマッチします。
  52.      *    デフォルトでは、この表現は行末記号にマッチしません。
  53.      * </p>
  54.      *
  55.      * @see java.util.regex.Pattern#DOTALL
  56.      */
  57.     DOTALL( java.util.regex.Pattern.DOTALL ),
  58.    
  59.     /**
  60.      * Unicodeに準拠した大文字と小文字を区別しないマッチングを有効にします。
  61.      * <p>このフラグと{@link #CASE_INSENSITIVE}フラグを同時に指定した場合は、
  62.      *    Unicode標準に準拠した大文字と小文字を区別しないマッチングが行われます。
  63.      *    デフォルトの大文字と小文字を区別しないマッチングでは、US-ASCII文字セットの文字だけがマッチします。
  64.      * </p>
  65.      *
  66.      * @see java.util.regex.Pattern#UNICODE_CASE
  67.      */
  68.     UNICODE_CASE( java.util.regex.Pattern.UNICODE_CASE ),
  69.    
  70.     /**
  71.      * 正規等価を有効にします。
  72.      * <p>このフラグを指定したときは、2つの文字の完全な正規分解がマッチした場合に限り、それらの文字がマッチするとみなされます。
  73.      *    たとえば、このフラグを指定すると、表現「{@literal a\u030A}」は文字列「{@literal \u00E5}」にマッチします。
  74.      *    デフォルトのマッチングでは、正規等価が考慮されません。
  75.      * </p>
  76.      *
  77.      * @see java.util.regex.Pattern#CANON_EQ
  78.      */
  79.     CANON_EQ( java.util.regex.Pattern.CANON_EQ );
  80.    
  81.     //JDK flag value
  82.     private final int value;
  83.    
  84.     private PatternFlag(int value) {
  85.         this.value = value;
  86.     }
  87.    
  88.     /**
  89.      * @return {@link java.util.regex.Pattern}に対応するフラグの値を返す。
  90.      */
  91.     public int getValue() {
  92.         return value;
  93.     }
  94.    
  95. }