<BODY BGCOLOR="white" onload="asd();">

PatternSet (Apache Ant API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.tools.ant.types
Class PatternSet


java.lang.Object

  |

  +--org.apache.tools.ant.ProjectComponent

        |

        +--org.apache.tools.ant.types.DataType

              |

              +--org.apache.tools.ant.types.PatternSet

public class PatternSet
extends DataType

Named collection of include/exclude tags.

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

Author:: Arnout J. Kuiper ajkuiper@wxs.nl

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, description, ref

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

project

Constructor Summary

PatternSet()


Method Summary

void addConfiguredPatternset(PatternSet p)


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

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

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

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

void setExcludes(java.lang.String excludes)
          Appends excludes to the current list of exclude patterns.

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

void setIncludes(java.lang.String includes)
          Appends includes to the current list of include patterns.

void setIncludesfile(java.io.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.

java.lang.String toString()


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

circularReference, dieOnCircularReference, getCheckedRef, getDescription, isReference, noChildrenAllowed, setDescription, tooManyAttributes

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

getProject, log, log, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PatternSet


public PatternSet()

Method Detail

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 class DataType

BuildException

addConfiguredPatternset


public void addConfiguredPatternset(PatternSet p)

createInclude


public PatternSet.NameEntry createInclude()

add a name entry on the include list

createIncludesFile


public PatternSet.NameEntry createIncludesFile()

add a name entry on the include files list

createExclude


public PatternSet.NameEntry createExclude()

add a name entry on the exclude list

createExcludesFile


public PatternSet.NameEntry createExcludesFile()

add a name entry on the exclude files list

setIncludes


public void setIncludes(java.lang.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

setExcludes


public void setExcludes(java.lang.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

setIncludesfile


public void setIncludesfile(java.io.File includesFile)
                     throws BuildException

Sets the name of the file containing the includes patterns.

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

setExcludesfile


public void setExcludesfile(java.io.File excludesFile)
                     throws BuildException

Sets the name of the file containing the excludes patterns.

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

append


public void append(PatternSet other,
                   Project p)

Adds the patterns of the other instance to this set.

getIncludePatterns


public java.lang.String[] getIncludePatterns(Project p)

Returns the filtered include patterns.

getExcludePatterns


public java.lang.String[] getExcludePatterns(Project p)