org.apache.tools.ant.taskdefs

Class Filter

Implemented Interfaces:
Cloneable

public class Filter
extends Task

Sets a token filter that is used by the file copy tasks to do token substitution. Sets multiple tokens by reading these from a file.
Since:
Ant 1.1

Field Summary

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

target, taskName, taskType, wrapper

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

description, location, project

Method Summary

void
execute()
Execute the task.
protected void
readFilters()
Read the filters.
void
setFiltersfile(File filtersFile)
The file from which the filters must be read.
void
setToken(String token)
The token string without @ delimiters.
void
setValue(String value)
The string that should replace the token during filtered copies.

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

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

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

Method Details

execute

public void execute()
            throws BuildException
Execute the task.
Overrides:
execute in interface Task
Throws:
BuildException - on error

readFilters

protected void readFilters()
            throws BuildException
Read the filters.
Throws:
BuildException - on error

setFiltersfile

public void setFiltersfile(File filtersFile)
The file from which the filters must be read. This file must be a formatted as a property file.
Parameters:
filtersFile - filter file

setToken

public void setToken(String token)
The token string without @ delimiters.
Parameters:
token - token to set

setValue

public void setValue(String value)
The string that should replace the token during filtered copies.
Parameters:
value - token replace value