パッケージ org.springframework.integration.file

インターフェース DirectoryScanner

すべての既知の実装クラス:
DefaultDirectoryScanner、HeadDirectoryScanner、RecursiveDirectoryScanner
public interface DirectoryScanner
ディレクトリをスキャンするための戦略。実装では、スキャンされたディレクトリのすべての子と孫を任意の順序で選択できます。このインターフェースは、RecursiveDirectoryScanner などのディレクトリ内のファイルの選択、ロック、順序付けのカスタマイズを可能にすることを目的としています。特定のファイルを無視することが唯一の要件である場合は、EntryListFilter の実装で十分です。
作成者:
Iwein Fuld

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    ListSE<FileSE>
    listFiles(FileSE directory)
    この実装に固有の戦略に従ってディレクトリをスキャンし、選択したファイルをファイル配列として返します。
    void
    setFilter(FileListFilter<FileSE> filter)
    このスキャナーで使用されるカスタムフィルターを設定します。
    void
    setLocker(FileLocker locker)
    このスキャナーが使用するカスタムロッカーを設定します。
    boolean
    tryClaim(FileSE file)
    処理するファイルを要求します。

  • メソッドの詳細

    • listFiles

      ListSE<FileSE> listFiles(FileSE directory) throws IllegalArgumentExceptionSE
      この実装に固有の戦略に従ってディレクトリをスキャンし、選択したファイルをファイル配列として返します。このメソッドは、フィルターによって拒否されたファイルを返すことはありません。
      パラメーター:
      directory - ファイルをスキャンするディレクトリ
      戻り値:
      ディレクトリの内容を表すファイルのリスト
      例外:
      IllegalArgumentExceptionSE - 入力が正しくない場合

    • setFilter

      void setFilter(FileListFilter<FileSE> filter)
      このスキャナーで使用されるカスタムフィルターを設定します。フィルターは、スキャナーが listFiles メソッドを介してファイルを提示する前に、ファイルを拒否する機会を得ます。スキャナーは、提供されたフィルターの制御外にある追加のフィルターを使用する場合があります。
      パラメーター:
      filter - 使用するカスタムフィルター

    • setLocker

      void setLocker(FileLocker locker)
      このスキャナーが使用するカスタムロッカーを設定します。ロッカーは、ファイルをロックし、すでにロックされているファイルに対する要求を拒否する機会を得ます。
      パラメーター:
      locker - 使用するカスタムロッカー

    • tryClaim

      boolean tryClaim(FileSE file)
      処理するファイルを要求します。ファイルに対する要求を達成するために必要な追加のセーフガードを決定するのは実装次第です。しかし、ロッカーが設定されている場合、実装はその lock メソッドを呼び出さなければならず、ロッカーがロックを許可しなかった場合は false を返さなければなりません。
      パラメーター:
      file - クレームするファイル
      戻り値:
      クレームが許可された場合は true、そうでない場合は false