Package org.apache.juneau.cp

Class FileFinder.Builder

java.lang.Object
org.apache.juneau.BeanBuilder<FileFinder>
org.apache.juneau.cp.FileFinder.Builder
Enclosing interface:
FileFinder
public static class FileFinder.Builder extends BeanBuilder<FileFinder>
Builder class.

  • Constructor Details

    • Builder

      protected Builder(BeanStore beanStore)
      Constructor.
      Parameters:
      beanStore - The bean store to use for creating beans.

  • Method Details

    • buildDefault

      protected FileFinder buildDefault()
      Description copied from class: BeanBuilder
      Creates the bean when the bean type is null or is the default value.
      Overrides:
      buildDefault in class BeanBuilder<FileFinder>
      Returns:
      A new bean.

    • cp

      public FileFinder.Builder cp(Class<?> c, String path, boolean recursive)
      Adds a class subpackage to the lookup paths.
      Parameters:
      c - The class whose package will be added to the lookup paths. Must not be null.
      path - The absolute or relative subpath.
      recursive - If true, also recursively adds all the paths of the parent classes as well.
      Returns:
      This object.

    • dir

      public FileFinder.Builder dir(String path)
      Adds a file system directory to the lookup paths.
      Parameters:
      path - The path relative to the working directory. Must not be null
      Returns:
      This object.

    • path

      public FileFinder.Builder path(Path path)
      Adds a file system directory to the lookup paths.
      Parameters:
      path - The directory path.
      Returns:
      This object.

    • caching

      public FileFinder.Builder caching(long cachingLimit)
      Enables in-memory caching of files for quicker retrieval.
      Parameters:
      cachingLimit - The maximum file size in bytes.
      Returns:
      This object.

    • include

      public FileFinder.Builder include(String... patterns)
      Specifies the regular expression file name patterns to use to include files being retrieved from the file source.
      Parameters:
      patterns - The regular expression include patterns.
      The default is ".*".
      Returns:
      This object.

    • exclude

      public FileFinder.Builder exclude(String... patterns)
      Specifies the regular expression file name pattern to use to exclude files from being retrieved from the file source.
      Parameters:
      patterns - The regular expression exclude patterns.
      If none are specified, no files will be excluded.
      Returns:
      This object.

    • impl

      public FileFinder.Builder impl(Object value)
      Description copied from class: BeanBuilder
      Overrides the bean returned by the BeanBuilder.build() method.

      Use this method if you want this builder to return an already-instantiated bean.

      Overrides:
      impl in class BeanBuilder<FileFinder>
      Parameters:
      value - The setting value.
      Returns:
      This object.

    • type

      public FileFinder.Builder type(Class<?> value)
      Description copied from class: BeanBuilder
      Overrides the bean type produced by the BeanBuilder.build() method.

      Use this method if you want to instantiated a bean subclass.

      Overrides:
      type in class BeanBuilder<FileFinder>
      Parameters:
      value - The setting value.
      Returns:
      This object.