|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
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:
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 | |
---|---|
PatternFilterable
|
exclude(String... excludes)
Adds an ANT style exclude pattern. |
PatternFilterable
|
exclude(Iterable excludes)
Adds an ANT style exclude pattern. |
PatternFilterable
|
exclude(Spec excludeSpec)
Adds an exclude spec. |
PatternFilterable
|
exclude(Closure excludeSpec)
Adds an exclude spec. |
Set
|
getExcludes()
Returns the set of exclude patterns. |
Set
|
getIncludes()
Returns the set of include patterns. |
PatternFilterable
|
include(String... includes)
Adds an ANT style include pattern. |
PatternFilterable
|
include(Iterable includes)
Adds an ANT style include pattern. |
PatternFilterable
|
include(Spec includeSpec)
Adds an include spec. |
PatternFilterable
|
include(Closure includeSpec)
Adds an include spec. |
PatternFilterable
|
setExcludes(Iterable excludes)
Set the allowable exclude patterns. |
PatternFilterable
|
setIncludes(Iterable includes)
Set the allowable include patterns. |
Method Detail |
---|
public PatternFilterable exclude(String... excludes)
excludes
- a vararg list of exclude patterns
public PatternFilterable exclude(Iterable excludes)
excludes
- a Iterable providing new exclude patterns
public PatternFilterable exclude(Spec excludeSpec)
excludeSpec
- the spec to add
public PatternFilterable exclude(Closure excludeSpec)
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.
excludeSpec
- the spec to add
public Set getExcludes()
public Set getIncludes()
public PatternFilterable include(String... includes)
includes
- a vararg list of include patterns
public PatternFilterable include(Iterable includes)
includes
- a Iterable providing more include patterns
public PatternFilterable include(Spec includeSpec)
includeSpec
- the spec to add
public PatternFilterable include(Closure includeSpec)
includeSpec
- the spec to add
public PatternFilterable setExcludes(Iterable excludes)
excludes
- an Iterable providing new exclude patterns
public PatternFilterable setIncludes(Iterable includes)
includes
- an Iterable providing new include patterns
Gradle API 1.8