クラス DefaultDirectoryScanner

java.lang.ObjectSE
org.springframework.integration.file.DefaultDirectoryScanner
実装済みのインターフェース一覧:
DirectoryScanner
既知の直属サブクラス
HeadDirectoryScanner, RecursiveDirectoryScanner
public class DefaultDirectoryScanner extends ObjectSE implements DirectoryScanner
デフォルトのディレクトリスキャナーと他のディレクトリスキャナーの基本クラス。フィルタリング、スキャン、ロック間のデフォルトの相互関係を管理します。
導入:
2.0
作成者:
Iwein Fuld, Gunnar Hillert, Artem Bilan

  • コンストラクターの詳細

  • 方法の詳細

    • setFilter

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

    • getFilter

      protected @Nullable FileListFilter<FileSE> getFilter()

    • setLocker

      public final void setLocker(FileLocker locker)
      インターフェースからコピーされた説明: DirectoryScanner
      このスキャナーが使用するカスタムロッカーを設定します。ロッカーは、ファイルをロックし、すでにロックされているファイルに対する要求を拒否する機会を得ます。
      次で指定:
      インターフェース DirectoryScanner 内の setLocker 
      パラメーター:
      locker - 使用するカスタムロッカー

    • getLocker

      protected @Nullable FileLocker getLocker()

    • tryClaim

      public boolean tryClaim(FileSE file)
      このクラスは最小限の実装を採用し、設定されている場合は単にロッカーに委譲します。
      次で指定:
      インターフェース DirectoryScanner 内の tryClaim 
      パラメーター:
      file - 主張しようとするファイル。
      戻り値:
      クレームが許可された場合は true、そうでない場合は false

    • listFiles

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

    • listEligibleFiles

      protected FileSE @Nullable [] listEligibleFiles(FileSE directory)
      サブクラスは、このメソッドをオーバーライドすることにより、リスト戦略を改善できます。ここで返されたファイルはフィルターに渡されます。
      パラメーター:
      directory - リストに使用するルートディレクトリ
      戻り値:
      このスキャナーが考慮すべきファイル