org.apache.tools.ant.types

Class PatternSet

public class PatternSet extends DataType implements Cloneable

Named collection of include/exclude tags.

Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example).

Nested Class Summary
classPatternSet.NameEntry
inner class to hold a name on list.
Constructor Summary
PatternSet()
Creates a new PatternSet instance.
Method Summary
voidaddConfiguredPatternset(PatternSet p)
This is a patternset nested element.
voidappend(PatternSet other, Project p)
Adds the patterns of the other instance to this set.
Objectclone()
PatternSet.NameEntrycreateExclude()
add a name entry on the exclude list
PatternSet.NameEntrycreateExcludesFile()
add a name entry on the exclude files list
PatternSet.NameEntrycreateInclude()
add a name entry on the include list
PatternSet.NameEntrycreateIncludesFile()
add a name entry on the include files list
String[]getExcludePatterns(Project p)
Returns the filtered include patterns.
String[]getIncludePatterns(Project p)
Returns the filtered include patterns.
voidsetExcludes(String excludes)
Appends excludes to the current list of exclude patterns.
voidsetExcludesfile(File excludesFile)
Sets the name of the file containing the excludes patterns.
voidsetIncludes(String includes)
Appends includes to the current list of include patterns.
voidsetIncludesfile(File includesFile)
Sets the name of the file containing the includes patterns.
voidsetRefid(Reference r)
Makes this instance in effect a reference to another PatternSet instance.
StringtoString()

Constructor Detail

PatternSet

public PatternSet()
Creates a new PatternSet instance.

Method Detail

addConfiguredPatternset

public void addConfiguredPatternset(PatternSet p)
This is a patternset nested element.

Parameters: p a configured patternset nested element.

append

public void append(PatternSet other, Project p)
Adds the patterns of the other instance to this set.

Parameters: other the other PatternSet instance. p the current project.

clone

public Object clone()

Returns: a clone of this patternset.

Since: Ant 1.6

createExclude

public PatternSet.NameEntry createExclude()
add a name entry on the exclude list

Returns: a nested exclude element to be configured.

createExcludesFile

public PatternSet.NameEntry createExcludesFile()
add a name entry on the exclude files list

Returns: a nested excludesfile element to be configured.

createInclude

public PatternSet.NameEntry createInclude()
add a name entry on the include list

Returns: a nested include element to be configured.

createIncludesFile

public PatternSet.NameEntry createIncludesFile()
add a name entry on the include files list

Returns: a nested includesfile element to be configured.

getExcludePatterns

public String[] getExcludePatterns(Project p)
Returns the filtered include patterns.

Parameters: p the current project.

Returns: the filtered excluded patterns.

getIncludePatterns

public String[] getIncludePatterns(Project p)
Returns the filtered include patterns.

Parameters: p the current project.

Returns: the filtered included patterns.

setExcludes

public void setExcludes(String excludes)
Appends excludes to the current list of exclude patterns. Patterns may be separated by a comma or a space.

Parameters: excludes the string containing the exclude patterns

setExcludesfile

public void setExcludesfile(File excludesFile)
Sets the name of the file containing the excludes patterns.

Parameters: excludesFile The file to fetch the exclude patterns from.

Throws: BuildException on error.

setIncludes

public void setIncludes(String includes)
Appends includes to the current list of include patterns. Patterns may be separated by a comma or a space.

Parameters: includes the string containing the include patterns

setIncludesfile

public void setIncludesfile(File includesFile)
Sets the name of the file containing the includes patterns.

Parameters: includesFile The file to fetch the include patterns from.

Throws: BuildException on error.

setRefid

public void setRefid(Reference r)
Makes this instance in effect a reference to another PatternSet instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

Parameters: r the reference to another patternset.

Throws: BuildException on error.

toString

public String toString()

Returns: a printable form of this object.

Copyright