PatternFilterable (Gradle API 5.2.1)
Date: 2019-02-08

Package org.gradle.api.tasks.util

## Interface PatternFilterable

- All Known Subinterfaces:
    `ConfigurableFileTree`, `CopySpec`, `SourceDirectorySet`
  All Known Implementing Classes:
    `AbstractArchiveTask`, `AbstractCompile`, `AbstractCopyTask`, `AbstractScalaCompile`, `AntlrTask`, `ApiJar`, `Checkstyle`, `CodeNarc`, `CoffeeScriptCompile`, `Copy`, `Ear`, `FindBugs`, `GroovyCompile`, `Groovydoc`, `Jar`, `Jar`, `JavaCompile`, `Javadoc`, `JavaScriptMinify`, `JsHint`, `PatternSet`, `PlatformJavaCompile`, `PlatformScalaCompile`, `PlayCoffeeScriptCompile`, `Pmd`, `ProcessResources`, `RoutesCompile`, `ScalaCompile`, `ScalaDoc`, `SourceTask`, `Sync`, `Tar`, `Test`, `TwirlCompile`, `War`, `Zip`

      public interface PatternFilterable

  A `PatternFilterable` represents some file container which Ant-style include and exclude patterns or specs can be applied to.

  Patterns may include:

  - '*' to match any number of characters
  - '?' to match any single character
  - '**' to match any number of directories or files

  Either '/' or '\' may be used in a pattern to separate directories. Patterns ending with '/' or '\' will have '**' automatically appended.

  Examples:

       all files ending with 'jsp' (including subdirectories)
          **/*.jsp

       all files beginning with 'template_' in the level1/level2 directory
          level1/level2/template_*

       all files (including subdirectories) beneath src/main/webapp
         src/main/webapp/

       all files beneath any .svn directory (including subdirectories) under src/main/java
         src/main/java/**/.svn/**

  You may also use a closure or `Spec` to specify which files to include or exclude. The closure or `Spec` is passed a `FileTreeElement`, and must return a boolean value.

  If no include patterns or specs are specified, then all files in this container will be included. If any include patterns or specs are specified, then a file is included if it matches any of the patterns or specs.

  If no exclude patterns or spec are specified, then no files will be excluded. If any exclude patterns or specs are specified, then a file is include only if it matches none of the patterns or specs.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `PatternFilterable` | `exclude​(Closure excludeSpec)` | Adds an exclude spec.
    `PatternFilterable` | `exclude​(Iterable<String> excludes)` | Adds an ANT style exclude pattern.
    `PatternFilterable` | `exclude​(String... excludes)` | Adds an ANT style exclude pattern.
    `PatternFilterable` | `exclude​(Spec<FileTreeElement> excludeSpec)` | Adds an exclude spec.
    `Set<String>` | `getExcludes()` | Returns the set of exclude patterns.
    `Set<String>` | `getIncludes()` | Returns the set of include patterns.
    `PatternFilterable` | `include​(Closure includeSpec)` | Adds an include spec.
    `PatternFilterable` | `include​(Iterable<String> includes)` | Adds an ANT style include pattern.
    `PatternFilterable` | `include​(String... includes)` | Adds an ANT style include pattern.
    `PatternFilterable` | `include​(Spec<FileTreeElement> includeSpec)` | Adds an include spec.
    `PatternFilterable` | `setExcludes​(Iterable<String> excludes)` | Set the allowable exclude patterns.
    `PatternFilterable` | `setIncludes​(Iterable<String> includes)` | Set the allowable include patterns.

- - ### Method Detail

    - #### getIncludes

          Set<String> getIncludes()

      Returns the set of include patterns.
      Returns:
        The include patterns. Returns an empty set when there are no include patterns.

    - #### getExcludes

          Set<String> getExcludes()

      Returns the set of exclude patterns.
      Returns:
        The exclude patterns. Returns an empty set when there are no exclude patterns.

    - #### setIncludes

          PatternFilterable setIncludes​(Iterable<String> includes)

      Set the allowable include patterns. Note that unlike `include(Iterable)` this replaces any previously defined includes.
      Parameters:
        `includes` - an Iterable providing new include patterns
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### setExcludes

          PatternFilterable setExcludes​(Iterable<String> excludes)

      Set the allowable exclude patterns. Note that unlike `exclude(Iterable)` this replaces any previously defined excludes.
      Parameters:
        `excludes` - an Iterable providing new exclude patterns
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### include

          PatternFilterable include​(String... includes)

      Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
      Parameters:
        `includes` - a vararg list of include patterns
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### include

          PatternFilterable include​(Iterable<String> includes)

      Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
      Parameters:
        `includes` - a Iterable providing more include patterns
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### include

          PatternFilterable include​(Spec<FileTreeElement> includeSpec)

      Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
      Parameters:
        `includeSpec` - the spec to add
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### include

          PatternFilterable include​(Closure includeSpec)

      Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a `FileTreeElement` as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
      Parameters:
        `includeSpec` - the spec to add
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### exclude

          PatternFilterable exclude​(String... excludes)

      Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
      Parameters:
        `excludes` - a vararg list of exclude patterns
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### exclude

          PatternFilterable exclude​(Iterable<String> excludes)

      Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
      Parameters:
        `excludes` - a Iterable providing new exclude patterns
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### exclude

          PatternFilterable exclude​(Spec<FileTreeElement> excludeSpec)

      Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
      Parameters:
        `excludeSpec` - the spec to add
      Returns:
        this
      See Also:
        `Pattern Format`

    - #### exclude

          PatternFilterable exclude​(Closure excludeSpec)

      Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a `FileTreeElement` as its parameter. The closure should return true or false. Example:

           copySpec {
             from 'source'
             into 'destination'
             //an example of excluding files from certain configuration:
             exclude { it.file in configurations.someConf.files }
           }

      If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
      Parameters:
        `excludeSpec` - the spec to add
      Returns:
        this
      See Also:
        `FileTreeElement`