|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--org.apache.tools.ant.Task
|
+--org.apache.tools.ant.taskdefs.MatchingTask
|
+--org.apache.tools.ant.taskdefs.Delete
Deletes a file or directory, or set of files defined by a fileset. The original delete task would delete a file, or a set of files using the include/exclude syntax. The deltree task would delete a directory tree. This task combines the functionality of these two originally distinct tasks.
Currently Delete extends MatchingTask. This is intend only to provide backwards compatibility for a release. The future position is to use nested filesets exclusively.
| Field Summary | |
protected java.io.File |
dir
|
protected java.io.File |
file
|
protected java.util.Vector |
filesets
|
protected boolean |
usedMatchingTask
|
| Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
fileset, useDefaultExcludes |
| Fields inherited from class org.apache.tools.ant.Task |
description, location, project, target, taskName, taskType, wrapper |
| Constructor Summary | |
Delete()
|
|
| Method Summary | |
void |
addFileset(FileSet set)
Adds a set of files (nested fileset attribute). |
PatternSet.NameEntry |
createExclude()
add a name entry on the exclude list |
PatternSet.NameEntry |
createInclude()
add a name entry on the include list |
PatternSet |
createPatternSet()
add a set of patterns |
void |
execute()
Delete the file(s). |
protected void |
removeDir(java.io.File d)
|
protected void |
removeFiles(java.io.File d,
java.lang.String[] files)
|
void |
setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not. |
void |
setDir(java.io.File dir)
Set the directory from which files are to be deleted |
void |
setExcludes(java.lang.String excludes)
Sets the set of exclude patterns. |
void |
setExcludesfile(java.io.File excludesfile)
Sets the name of the file containing the includes patterns. |
void |
setFile(java.io.File file)
Set the name of a single file to be removed. |
void |
setIncludes(java.lang.String includes)
Sets the set of include patterns. |
void |
setIncludesfile(java.io.File includesfile)
Sets the name of the file containing the includes patterns. |
void |
setVerbose(boolean verbose)
Used to force listing of all names of deleted files. |
| Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
getDirectoryScanner, XsetIgnore, XsetItems |
| Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getProject, getRuntimeConfigurableWrapper, getTaskName, init, log, log, maybeConfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected java.io.File file
protected java.io.File dir
protected java.util.Vector filesets
protected boolean usedMatchingTask
| Constructor Detail |
public Delete()
| Method Detail |
public void setFile(java.io.File file)
file - the file to be deletedpublic void setDir(java.io.File dir)
dir - the directory path.public void setVerbose(boolean verbose)
verbose - "true" or "on"public void addFileset(FileSet set)
public PatternSet.NameEntry createInclude()
createInclude in class MatchingTaskpublic PatternSet.NameEntry createExclude()
createExclude in class MatchingTaskpublic PatternSet createPatternSet()
createPatternSet in class MatchingTaskpublic void setIncludes(java.lang.String includes)
setIncludes in class MatchingTaskincludes - the string containing the include patternspublic void setExcludes(java.lang.String excludes)
setExcludes in class MatchingTaskexcludes - the string containing the exclude patternspublic void setDefaultexcludes(boolean useDefaultExcludes)
setDefaultexcludes in class MatchingTaskuseDefaultExcludes - "true"|"on"|"yes" when default exclusions
should be used, "false"|"off"|"no" when they
shouldn't be used.public void setIncludesfile(java.io.File includesfile)
setIncludesfile in class MatchingTaskincludesfile - A string containing the filename to fetch
the include patterns from.public void setExcludesfile(java.io.File excludesfile)
setExcludesfile in class MatchingTaskexcludesfile - A string containing the filename to fetch
the include patterns from.
public void execute()
throws BuildException
execute in class Taskorg.apache.tools.ant.TaskBuildException - if someting goes wrong with the buildprotected void removeDir(java.io.File d)
protected void removeFiles(java.io.File d,
java.lang.String[] files)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||