org.opengion.fukurou.util

## クラス HybsFileFilter

- java.lang.Object
- - org.opengion.fukurou.util.HybsFileFilter

- すべての実装されたインタフェース:
    java.io.FileFilter, FileOperationFileFilter

      public final class HybsFileFilter
      extends java.lang.Object
      implements java.io.FileFilter, FileOperationFileFilter

  HybsFileFilter.java は、複数の FileFilter を順次実行する フィルタクラスです。 FileFilter インターフェースを継承し、File クラスの listFiles(FileFilter) メソッドに 渡すことができます。 Filterに設定された複数のフィルタすべてを満たす場合の時のみ、accept(File pathname) メソッドは、true を返します。 FileOperationFileFilterインターフェースも継承しており、こちらはopenGionで実装している FileOperationを扱う事が可能です。 この実装は同期化されません。
  変更履歴:

    5.10.8.0 (2019/02/01) FileOperationFileFilterでのフィルタ処理対応

  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `HybsFileFilter()` 指定された抽象パス名がパス名リストに含まれる必要がある場合、スルー(選択)されます。
    `HybsFileFilter(boolean useDIR)` 引数に、ディレクトリの判定を行うかどうかを指定するコンストラクタです。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `accept(java.io.File pathname)` 指定された抽象パス名がパス名リストに含まれる必要がある場合、スルー(選択)されます。
    `boolean` | `accept(FileOperationInfo exFileInfo)` 指定された抽象パス名がパス名リストに含まれる必要がある場合、スルー(選択)されます。
    `void` | `addFileFilter(java.io.FileFilter filter)` 外部指定フィルタ： 内部判定条件に、フィルタを追加します。
    `void` | `addFileFilter(FileOperationFileFilter exFilter)` 外部指定フィルタ： 内部判定条件に、フィルタを追加します。
    `void` | `endsWith(java.lang.String suffix)` 内部判定フィルタ： 指定された接頭辞で終わる場合、スルー(選択)されます。
    `void` | `endsWith(java.lang.String suffix, boolean reverse)` 内部判定フィルタ： 指定された接頭辞で終わる場合、スルー(選択)されます。
    `void` | `fileEquals(java.lang.String str)` 内部判定フィルタ： ファイル名が一致する場合、スルー(選択)されます。
    `void` | `fileEquals(java.lang.String str, boolean reverse)` 内部判定フィルタ： ファイル名が一致する場合、スルー(選択)されます。
    `void` | `instr(java.lang.String str)` 内部判定フィルタ： 指定された文字列がファイル名に含まれる場合、スルー(選択)されます。
    `void` | `instr(java.lang.String str, boolean reverse)` 内部判定フィルタ： 指定された文字列がファイル名に含まれる場合、スルー(選択)されます。
    `void` | `isHidden(java.lang.String flag)` 内部判定フィルタ： ファイルが hidden の場合、スルー(選択)されます。
    `void` | `isHidden(java.lang.String flag, boolean reverse)` 内部判定フィルタ： ファイルが hidden の場合、スルー(選択)されます。
    `void` | `isLarger(java.lang.String slen)` 内部判定フィルタ： 指定の大きさより大きいファイルの場合、スルー(選択)されます。
    `void` | `isSmaller(java.lang.String slen)` 内部判定フィルタ： 指定の大きさより小さいファイルの場合、スルー(選択)されます。
    `void` | `lastModified(java.lang.String modify)` 内部判定フィルタ： 指定のタイムスタンプ以後に変更されている場合、スルー(選択)されます。
    `void` | `matches(java.lang.String str)` 内部判定フィルタ： ファイル名が、指定された 正規表現 と一致する場合、スルー(選択)されます 大文字小文字は区別しません。
    `void` | `matches(java.lang.String str, boolean reverse)` 内部判定フィルタ： ファイル名が、指定された 正規表現 と一致する場合、スルー(選択)されます 大文字小文字は区別しません。
    `void` | `startsWith(java.lang.String prefix)` 内部判定フィルタ： 指定された接頭辞で始まる場合、スルー(選択)されます。
    `void` | `startsWith(java.lang.String prefix, boolean reverse)` 内部判定フィルタ： 指定された接頭辞で始まる場合、スルー(選択)されます。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### HybsFileFilter

          public HybsFileFilter(boolean useDIR)

      引数に、ディレクトリの判定を行うかどうかを指定するコンストラクタです。 ここで、true を指定すると、ファイル、ディレクトリの両方に対して 処理を実施します。 ディレクトリの判定の場合、acceptメソッドで、false が返ると それ以下の処理も実行されません。
      パラメータ:
        `useDIR` - 判定をディレクトリでも行うかどうか
      変更履歴:

        5.1.2.0 (2010/01/01) 引数つきコンストラクタ追加

    - #### HybsFileFilter

          public HybsFileFilter()

      指定された抽象パス名がパス名リストに含まれる必要がある場合、スルー(選択)されます。 ここでの判定ロジックでは、ファイルについてのみ処理します。 ディレクトリは、常に、true を返します。

  - ### メソッドの詳細

    - #### accept

          public boolean accept(java.io.File pathname)

      指定された抽象パス名がパス名リストに含まれる必要がある場合、スルー(選択)されます。 ここでの判定ロジックでは、ファイルについてのみ処理します。 ディレクトリは、常に、true を返します。
      定義:
        `accept` インタフェース内 `java.io.FileFilter`
      パラメータ:
        `pathname` - ファイルオブジェクト
      戻り値:
        パス名リストに含まれるかどうか
      関連項目:
        `FileFilter.accept(File)`

    - #### accept

          public boolean accept(FileOperationInfo exFileInfo)

      指定された抽象パス名がパス名リストに含まれる必要がある場合、スルー(選択)されます。 ここでの判定ロジックでは、ファイルについてのみ処理します。 ディレクトリは、常に、true を返します。 5.10.8.0 (2019/02/01) ADD
      定義:
        `accept` インタフェース内 `FileOperationFileFilter`
      パラメータ:
        `exFileInfo` - 拡張ファイルオブジェクト
      戻り値:
        パス名リストに含まれるかどうか
      関連項目:
        `FileOperationFileFilter.accept(FileOperationInfo)`

    - #### addFileFilter

          public void addFileFilter(java.io.FileFilter filter)

      外部指定フィルタ： 内部判定条件に、フィルタを追加します。 引数が null の場合は、追加しません。
      パラメータ:
        `filter` - 外部指定フィルタ

    - #### addFileFilter

          public void addFileFilter(FileOperationFileFilter exFilter)

      外部指定フィルタ： 内部判定条件に、フィルタを追加します。 引数が null の場合は、追加しません。
      パラメータ:
        `exFilter` - 拡張外部指定フィルタ

    - #### startsWith

          public void startsWith(java.lang.String prefix)

      内部判定フィルタ： 指定された接頭辞で始まる場合、スルー(選択)されます。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。
      パラメータ:
        `prefix` - 接頭辞
      関連項目:
        `String.startsWith(String)`

    - #### startsWith

          public void startsWith(java.lang.String prefix,
                        boolean reverse)

      内部判定フィルタ： 指定された接頭辞で始まる場合、スルー(選択)されます。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。 reverse = true に設定すると、結果を反転させます。
      パラメータ:
        `prefix` - 接頭辞
        `reverse` - true:結果を反転する
      関連項目:
        `String.startsWith(String)`
      変更履歴:

        5.1.2.0 (2010/01/01) reverse属性の追加

    - #### endsWith

          public void endsWith(java.lang.String suffix)

      内部判定フィルタ： 指定された接頭辞で終わる場合、スルー(選択)されます。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。
      パラメータ:
        `suffix` - 接尾辞
      関連項目:
        `String.endsWith(String)`

    - #### endsWith

          public void endsWith(java.lang.String suffix,
                      boolean reverse)

      内部判定フィルタ： 指定された接頭辞で終わる場合、スルー(選択)されます。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。 reverse = true に設定すると、結果を反転させます。
      パラメータ:
        `suffix` - 接尾辞
        `reverse` - true:結果を反転する
      関連項目:
        `String.endsWith(String)`
      変更履歴:

        5.1.2.0 (2010/01/01) reverse属性の追加

    - #### instr

          public void instr(java.lang.String str)

      内部判定フィルタ： 指定された文字列がファイル名に含まれる場合、スルー(選択)されます。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。
      パラメータ:
        `str` - 指定の部分文字列

    - #### instr

          public void instr(java.lang.String str,
                   boolean reverse)

      内部判定フィルタ： 指定された文字列がファイル名に含まれる場合、スルー(選択)されます。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。 reverse = true に設定すると、結果を反転させます。
      パラメータ:
        `str` - 指定の部分文字列
        `reverse` - 結果を反転させるかどうか(true:反転)
      変更履歴:

        5.1.2.0 (2010/01/01) reverse属性の追加

    - #### fileEquals

          public void fileEquals(java.lang.String str)

      内部判定フィルタ： ファイル名が一致する場合、スルー(選択)されます。 大文字小文字は区別しません。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。
      パラメータ:
        `str` - ファイル名文字列

    - #### fileEquals

          public void fileEquals(java.lang.String str,
                        boolean reverse)

      内部判定フィルタ： ファイル名が一致する場合、スルー(選択)されます。 大文字小文字は区別しません。 引数が null の場合は、追加しません。 引数に、'|' 区切り文字で複数設定した場合は、OR 判断(どれかが一致)します。 reverse = true に設定すると、結果を反転させます。
      パラメータ:
        `str` - ファイル名文字列
        `reverse` - true:結果を反転する
      変更履歴:

        5.1.2.0 (2010/01/01) reverse属性の追加

    - #### matches

          public void matches(java.lang.String str)

      内部判定フィルタ： ファイル名が、指定された 正規表現 と一致する場合、スルー(選択)されます 大文字小文字は区別しません。 Pattern.compile( str,Pattern.CASE_INSENSITIVE ) ; pattern.matcher( pathname.getName() ).find() == true と同じ結果が得られます。 引数が null の場合は、追加しません。
      パラメータ:
        `str` - ファイル名文字列(正規表現)
      関連項目:
        `Pattern.compile(String,int)`, `Matcher.find()`

    - #### matches

          public void matches(java.lang.String str,
                     boolean reverse)

      内部判定フィルタ： ファイル名が、指定された 正規表現 と一致する場合、スルー(選択)されます 大文字小文字は区別しません。 Pattern.compile( str,Pattern.CASE_INSENSITIVE ) ; pattern.matcher( pathname.getName() ).find() == true と同じ結果が得られます。 引数が null の場合は、追加しません。 reverse = true に設定すると、結果を反転させます。
      パラメータ:
        `str` - ファイル名文字列(正規表現)
        `reverse` - true:結果を反転する
      関連項目:
        `Pattern.compile(String,int)`, `Matcher.find()`
      変更履歴:

        5.1.2.0 (2010/01/01) reverse属性の追加

    - #### lastModified

          public void lastModified(java.lang.String modify)

      内部判定フィルタ： 指定のタイムスタンプ以後に変更されている場合、スルー(選択)されます。 ディレクトリは、ここの判定では無視します。(必ず true を返します) 日付けの指定に、YYYYMMDD 形式の ８文字数字文字列以外に、 TODAY や YESTERDAY なども使用できます。 TODAY は、実行日の 00:00:00 を基準時刻とし、YESTERDAY は、その前日になります。 引数が null の場合は、追加しません。
      パラメータ:
        `modify` - 時刻を表す long 値(ミリ秒単位)

    - #### isLarger

          public void isLarger(java.lang.String slen)

      内部判定フィルタ： 指定の大きさより大きいファイルの場合、スルー(選択)されます。 指定はバイト単位ですが、**KB , **MB , **GB などの単位を付ける事も可能です。 現時点では、K , KB , M , MB , G , GB のみ指定可能です。
      パラメータ:
        `slen` - ファイルの大きさ(バイト単位)。同値を含む
      変更履歴:

        5.7.4.3 (2014/03/28) isLarger,isSmaller属性を文字列に変更

    - #### isSmaller

          public void isSmaller(java.lang.String slen)

      内部判定フィルタ： 指定の大きさより小さいファイルの場合、スルー(選択)されます。 引数が 0以下(マイナス) の場合は、追加しません。
      パラメータ:
        `slen` - ファイルの大きさ(バイト単位)。同値を含まない。
      変更履歴:

        5.7.4.3 (2014/03/28) isLarger,isSmaller属性を文字列に変更

    - #### isHidden

          public void isHidden(java.lang.String flag)

      内部判定フィルタ： ファイルが hidden の場合、スルー(選択)されます。 引数がtrueの場合は、hiddenファイルのみを選択します。 falseの場合は、hiddenファイル以外を選択します。(つまり hiddenファイルをブロックします。) hidden をブロックしたい場合は、false を設定し、すべて選択したい場合は、filter設定をしない事になります。 引数が null の場合は、追加しません。
      パラメータ:
        `flag` - [true:/false]
      変更履歴:

        5.7.5.0 (2014/04/04) 新規追加

    - #### isHidden

          public void isHidden(java.lang.String flag,
                      boolean reverse)

      内部判定フィルタ： ファイルが hidden の場合、スルー(選択)されます。 引数がtrueの場合は、hiddenファイルのみを選択します。 falseの場合は、hiddenファイル以外を選択します。(つまり hiddenファイルをブロックします。) hidden をブロックしたい場合は、false を設定し、すべて選択したい場合は、filter設定をしない事になります。 reverse = true に設定すると、結果を反転させます。
      パラメータ:
        `flag` - [true:/false]
        `reverse` - true:結果を反転する
      変更履歴:

        5.7.5.0 (2014/04/04) 新規追加

    - #### toString

          public java.lang.String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        このクラスの文字列表現

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.