Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.types

Class PatternSet

Implemented Interfaces:
Cloneable
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

class
PatternSet.NameEntry
inner class to hold a name on list.

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

PatternSet()
Creates a new PatternSet instance.

Method Summary

void
addConfiguredPatternset(PatternSet p)
This is a patternset nested element.
void
append(PatternSet other, Project p)
Adds the patterns of the other instance to this set.
Object
clone()
PatternSet.NameEntry
createExclude()
add a name entry on the exclude list
PatternSet.NameEntry
createExcludesFile()
add a name entry on the exclude files list
PatternSet.NameEntry
createInclude()
add a name entry on the include list
PatternSet.NameEntry
createIncludesFile()
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.
boolean
hasPatterns(Project p)
Helper for FileSet classes.
void
setExcludes(String excludes)
Appends excludes to the current list of exclude patterns.
void
setExcludesfile(File excludesFile)
Sets the name of the file containing the excludes patterns.
void
setIncludes(String includes)
Appends includes to the current list of include patterns.
void
setIncludesfile(File includesFile)
Sets the name of the file containing the includes patterns.
void
setRefid(Reference r)
Makes this instance in effect a reference to another PatternSet instance.
String
toString()

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, toString, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

PatternSet

public PatternSet()
Creates a new PatternSet instance.

Method Details

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()
Overrides:
clone in interface DataType
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.

hasPatterns

public boolean hasPatterns(Project p)
Helper for FileSet classes. Check if there are patterns defined.
Parameters:
p - the current project.
Returns:
true if there are 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)
            throws BuildException
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)
            throws BuildException
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)
            throws BuildException
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.

Overrides:
setRefid in interface DataType
Parameters:
r - the reference to another patternset.
Throws:
BuildException - on error.

toString

public String toString()
Overrides:
toString in interface DataType
Returns:
a printable form of this object.

Overview Package Tree Index Deprecated About