Modifier and Type	Class and Description
private class	Replace.FileInput Class reading a file in small chunks, and presenting these chunks in a StringBuffer.
private class	Replace.FileOutput Component writing a file in chunks, taking the chunks from the Replacefilter.
public class	Replace.NestedString An inline string to use as the replacement text.
public class	Replace.Replacefilter A filter to apply.

Modifier and Type	Field and Description
private File	dir
private String	encoding The encoding used to read and write files - if null, uses default
private boolean	failOnNoReplacements
private static final FileUtils	FILE_UTILS
private int	fileCount
private boolean	preserveLastModified
private Properties	properties
private Resource	propertyResource
private int	replaceCount
private Resource	replaceFilterResource
private List<Replace.Replacefilter>	replacefilters
private Union	resources
private File	sourceFile
private boolean	summary
private Replace.NestedString	token
private Replace.NestedString	value

Access	Constructor and Description
public	Replace()

Method Summary

Modifier and Type	Method and Description
public void	addConfigured(ResourceCollection ResourceCollection rc) Support arbitrary file system based resource collections.
private StringBuffer	Returns: `StringBuffer` containing the output of the last filter. buildFilterChain(StringBuffer `StringBuffer` containing the input for the first filter. inputBuffer) Creates the chain of filters to operate.
private Replace.Replacefilter	Returns: a nested `Replacefilter` object to be configured. createPrimaryfilter() Adds the token and value as first <replacefilter> element.
public Replace.Replacefilter	Returns: a nested `Replacefilter` object to be configured. createReplacefilter() Add a nested <replacefilter> element.
public Replace.NestedString	Returns: nested token `NestedString` to configure. createReplaceToken() Create a token to filter as the text of a nested element.
public Replace.NestedString	Returns: replacement value `NestedString` to configure. createReplaceValue() Create a string to replace the token as the text of a nested element.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Do the execution.
private void	flushFilterChain() Flushes all filters.
private Iterator<String>	getOrderedIterator(Properties Properties props) Sort keys by size so that tokens that are substrings of other strings are tried later.
public Properties	Returns: loaded `Properties` object. getProperties(File the file to load the properties from. propertyFile) Load a properties file.
public Properties	Returns: loaded `Properties` object. getProperties(Resource the resource to load the properties from. propertyResource) Load a properties resource.
private void	logFilterChain(String `String`. filename) Logs the chain of filters to operate on the file.
private void	processFile(File the source `File`. src) Perform the replacement on the given file.
private boolean	Returns: true if the filter chain produced new output. processFilterChain() Performs the normal processing of the filters.
public void	setDir(File `File` representing the base directory. dir) The base directory to use when replacing a token in multiple files; required if `file` is not defined.
public void	setEncoding(String the encoding to use on the files. encoding) Set the file encoding to use on the files read and written by the task; optional, defaults to default JVM encoding.
public void	setFailOnNoReplacements(boolean boolean b) Whether the build should fail if nothing has been replaced.
public void	setFile(File source `File`. file) Set the source file; required unless `dir` is set.
public void	setPreserveLastModified(boolean boolean b) Whether the file timestamp shall be preserved even if the file is modified.
public void	setPropertyFile(File `File` to load. propertyFile) The name of a property file from which properties specified using nested `<replacefilter>` elements are drawn; required only if the property attribute of `<replacefilter>` is used.
public void	setPropertyResource(Resource `Resource` to load. propertyResource) A resource from which properties specified using nested `<replacefilter>` elements are drawn; required only if the property attribute of `<replacefilter>` is used.
public void	setReplaceFilterFile(File `File` to load. replaceFilterFile) Sets the name of a property file containing filters; optional.
public void	setReplaceFilterResource(Resource `Resource` to load. replaceFilter) Sets the name of a resource containing filters; optional.
public void	setSummary(boolean `boolean` whether a summary of the replace operation should be logged. summary) Indicates whether a summary of the replace operation should be produced, detailing how many token occurrences and files were processed; optional, default=`false`.
public void	setToken(String token `String`. token) Set the string token to replace; required unless a nested `replacetoken` element or the `replacefilterresource` attribute is used.
public void	setValue(String replacement value. value) Set the string value to use as token replacement; optional, default is the empty string "".
private void	stringReplace(StringBuilder StringBuilder str, String String str1, String String str2) Replace occurrences of str1 in StringBuffer str with str2.
public void	validateAttributes() Validate attributes provided for this task in .xml build file.
public void	validateReplacefilters() Validate nested elements.

Field Detail

dir	back to summary
private File dir

encoding	back to summary
private String encoding The encoding used to read and write files - if null, uses default

failOnNoReplacements	back to summary
private boolean failOnNoReplacements

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS

fileCount	back to summary
private int fileCount

preserveLastModified	back to summary
private boolean preserveLastModified

properties	back to summary
private Properties properties

propertyResource	back to summary
private Resource propertyResource

replaceCount	back to summary
private int replaceCount

replaceFilterResource	back to summary
private Resource replaceFilterResource

replacefilters	back to summary
private List<Replace.Replacefilter> replacefilters

resources	back to summary
private Union resources

sourceFile	back to summary
private File sourceFile

summary	back to summary
private boolean summary

token	back to summary
private Replace.NestedString token

value	back to summary
private Replace.NestedString value

Constructor Detail

Replace	back to summary
public Replace()

Method Detail

addConfigured	back to summary
public void addConfigured(ResourceCollection rc) Support arbitrary file system based resource collections. Parameters rc:ResourceCollection ResourceCollection Since Ant 1.8.0

addConfigured

back to summary

public void addConfigured(ResourceCollection rc)

Support arbitrary file system based resource collections.

Parameters

rc:ResourceCollection: ResourceCollection

Since

Ant 1.8.0

buildFilterChain back to summary

buildFilterChain	back to summary
private StringBuffer buildFilterChain(StringBuffer inputBuffer) Creates the chain of filters to operate. Parameters inputBuffer:StringBuffer `StringBuffer` containing the input for the first filter. Returns:StringBuffer `StringBuffer` containing the output of the last filter.

private StringBuffer buildFilterChain(StringBuffer inputBuffer)

Creates the chain of filters to operate.

Parameters

inputBuffer:StringBuffer: StringBuffer containing the input for the first filter.

Returns:StringBuffer

StringBuffer containing the output of the last filter.

createPrimaryfilter back to summary

createPrimaryfilter	back to summary
private Replace.Replacefilter createPrimaryfilter() Adds the token and value as first <replacefilter> element. The token and value are always processed first. Returns:Replace.Replacefilter a nested `Replacefilter` object to be configured.

private Replace.Replacefilter createPrimaryfilter()

Adds the token and value as first <replacefilter> element. The token and value are always processed first.

Returns:Replace.Replacefilter: a nested Replacefilter object to be configured.

createReplacefilter back to summary

createReplacefilter	back to summary
public Replace.Replacefilter createReplacefilter() Add a nested <replacefilter> element. Returns:Replace.Replacefilter a nested `Replacefilter` object to be configured.

public Replace.Replacefilter createReplacefilter()

Add a nested <replacefilter> element.

Returns:Replace.Replacefilter: a nested Replacefilter object to be configured.

createReplaceToken back to summary

createReplaceToken	back to summary
public Replace.NestedString createReplaceToken() Create a token to filter as the text of a nested element. Returns:Replace.NestedString nested token `NestedString` to configure.

public Replace.NestedString createReplaceToken()

Create a token to filter as the text of a nested element.

Returns:Replace.NestedString: nested token NestedString to configure.

createReplaceValue back to summary

createReplaceValue	back to summary
public Replace.NestedString createReplaceValue() Create a string to replace the token as the text of a nested element. Returns:Replace.NestedString replacement value `NestedString` to configure.

public Replace.NestedString createReplaceValue()

Create a string to replace the token as the text of a nested element.

Returns:Replace.NestedString: replacement value NestedString to configure.

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Do the execution. Annotations @Override Exceptions BuildException: if we can't build

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Do the execution.

Annotations

@Override

Exceptions

BuildException:: if we can't build

flushFilterChain	back to summary
private void flushFilterChain() Flushes all filters.

getOrderedIterator	back to summary
private Iterator<String> getOrderedIterator(Properties props) Sort keys by size so that tokens that are substrings of other strings are tried later. Parameters props:Properties Properties

getOrderedIterator

back to summary

private Iterator<String> getOrderedIterator(Properties props)

Sort keys by size so that tokens that are substrings of other strings are tried later.

Parameters

props:Properties: Properties

getProperties back to summary

getProperties	back to summary
public Properties getProperties(File propertyFile) throws BuildException Load a properties file. Parameters propertyFile:File the file to load the properties from. Returns:Properties loaded `Properties` object. Exceptions BuildException: if the file could not be found or read.

public Properties getProperties(File propertyFile) throws BuildException

Load a properties file.

Parameters

propertyFile:File: the file to load the properties from.

Returns:Properties

loaded Properties object.

Exceptions

BuildException:: if the file could not be found or read.

getProperties back to summary

getProperties	back to summary
public Properties getProperties(Resource propertyResource) throws BuildException Load a properties resource. Parameters propertyResource:Resource the resource to load the properties from. Returns:Properties loaded `Properties` object. Exceptions BuildException: if the resource could not be found or read. Since Ant 1.8.0

public Properties getProperties(Resource propertyResource) throws BuildException

Load a properties resource.

Parameters

propertyResource:Resource: the resource to load the properties from.

Returns:Properties

loaded Properties object.

Exceptions

BuildException:: if the resource could not be found or read.

Since

Ant 1.8.0

logFilterChain back to summary

logFilterChain	back to summary
private void logFilterChain(String filename) Logs the chain of filters to operate on the file. Parameters filename:String `String`.

private void logFilterChain(String filename)

Logs the chain of filters to operate on the file.

Parameters

filename:String: String.

processFile back to summary

processFile	back to summary
private void processFile(File src) throws BuildException Perform the replacement on the given file. The replacement is performed on a temporary file which then replaces the original file. Parameters src:File the source `File`.

private void processFile(File src) throws BuildException

Perform the replacement on the given file. The replacement is performed on a temporary file which then replaces the original file.

Parameters

src:File: the source File.

processFilterChain	back to summary
private boolean processFilterChain() Performs the normal processing of the filters. Returns:boolean true if the filter chain produced new output.

processFilterChain

back to summary

private boolean processFilterChain()

Performs the normal processing of the filters.

Returns:boolean: true if the filter chain produced new output.

setDir back to summary

setDir	back to summary
public void setDir(File dir) The base directory to use when replacing a token in multiple files; required if `file` is not defined. Parameters dir:File `File` representing the base directory.

public void setDir(File dir)

The base directory to use when replacing a token in multiple files; required if file is not defined.

Parameters

dir:File: File representing the base directory.

setEncoding	back to summary
public void setEncoding(String encoding) Set the file encoding to use on the files read and written by the task; optional, defaults to default JVM encoding. Parameters encoding:String the encoding to use on the files.

setEncoding

back to summary

public void setEncoding(String encoding)

Set the file encoding to use on the files read and written by the task; optional, defaults to default JVM encoding.

Parameters

encoding:String: the encoding to use on the files.

setFailOnNoReplacements	back to summary
public void setFailOnNoReplacements(boolean b) Whether the build should fail if nothing has been replaced. Parameters b:boolean boolean Since Ant 1.8.0

setFailOnNoReplacements

back to summary

public void setFailOnNoReplacements(boolean b)

Whether the build should fail if nothing has been replaced.

Parameters

b:boolean: boolean

Since

Ant 1.8.0

setFile back to summary

setFile	back to summary
public void setFile(File file) Set the source file; required unless `dir` is set. Parameters file:File source `File`.

public void setFile(File file)

Set the source file; required unless dir is set.

Parameters

file:File: source File.

setPreserveLastModified	back to summary
public void setPreserveLastModified(boolean b) Whether the file timestamp shall be preserved even if the file is modified. Parameters b:boolean boolean Since Ant 1.8.0

setPreserveLastModified

back to summary

public void setPreserveLastModified(boolean b)

Whether the file timestamp shall be preserved even if the file is modified.

Parameters

b:boolean: boolean

Since

Ant 1.8.0

setPropertyFile back to summary

setPropertyFile	back to summary
public void setPropertyFile(File propertyFile) The name of a property file from which properties specified using nested `<replacefilter>` elements are drawn; required only if the property attribute of `<replacefilter>` is used. Parameters propertyFile:File `File` to load.

public void setPropertyFile(File propertyFile)

The name of a property file from which properties specified using nested <replacefilter> elements are drawn; required only if the property attribute of <replacefilter> is used.

Parameters

propertyFile:File: File to load.

setPropertyResource back to summary

setPropertyResource	back to summary
public void setPropertyResource(Resource propertyResource) A resource from which properties specified using nested `<replacefilter>` elements are drawn; required only if the property attribute of `<replacefilter>` is used. Parameters propertyResource:Resource `Resource` to load. Since Ant 1.8.0

public void setPropertyResource(Resource propertyResource)

A resource from which properties specified using nested <replacefilter> elements are drawn; required only if the property attribute of <replacefilter> is used.

Parameters

propertyResource:Resource: Resource to load.

Since

Ant 1.8.0

setReplaceFilterFile back to summary

setReplaceFilterFile	back to summary
public void setReplaceFilterFile(File replaceFilterFile) Sets the name of a property file containing filters; optional. Each property will be treated as a replacefilter where token is the name of the property and value is the value of the property. Parameters replaceFilterFile:File `File` to load.

public void setReplaceFilterFile(File replaceFilterFile)

Sets the name of a property file containing filters; optional. Each property will be treated as a replacefilter where token is the name of the property and value is the value of the property.

Parameters

replaceFilterFile:File: File to load.

setReplaceFilterResource back to summary

setReplaceFilterResource	back to summary
public void setReplaceFilterResource(Resource replaceFilter) Sets the name of a resource containing filters; optional. Each property will be treated as a replacefilter where token is the name of the property and value is the value of the property. Parameters replaceFilter:Resource `Resource` to load. Since Ant 1.8.0

public void setReplaceFilterResource(Resource replaceFilter)

Sets the name of a resource containing filters; optional. Each property will be treated as a replacefilter where token is the name of the property and value is the value of the property.

Parameters

replaceFilter:Resource: Resource to load.

Since

Ant 1.8.0

setSummary back to summary

setSummary	back to summary
public void setSummary(boolean summary) Indicates whether a summary of the replace operation should be produced, detailing how many token occurrences and files were processed; optional, default=`false`. Parameters summary:boolean `boolean` whether a summary of the replace operation should be logged.

public void setSummary(boolean summary)

Indicates whether a summary of the replace operation should be produced, detailing how many token occurrences and files were processed; optional, default=false.

Parameters

summary:boolean: boolean whether a summary of the replace operation should be logged.

setToken back to summary

setToken	back to summary
public void setToken(String token) Set the string token to replace; required unless a nested `replacetoken` element or the `replacefilterresource` attribute is used. Parameters token:String token `String`.

public void setToken(String token)

Set the string token to replace; required unless a nested replacetoken element or the replacefilterresource attribute is used.

Parameters

token:String: token String.

setValue	back to summary
public void setValue(String value) Set the string value to use as token replacement; optional, default is the empty string "". Parameters value:String replacement value.

setValue

back to summary

public void setValue(String value)

Set the string value to use as token replacement; optional, default is the empty string "".

Parameters

value:String: replacement value.

stringReplace	back to summary
private void stringReplace(StringBuilder str, String str1, String str2) Replace occurrences of str1 in StringBuffer str with str2. Parameters str:StringBuilder StringBuilder str1:String String str2:String String

stringReplace

back to summary

private void stringReplace(StringBuilder str, String str1, String str2)

Replace occurrences of str1 in StringBuffer str with str2.

Parameters

str:StringBuilder: StringBuilder
str1:String: String
str2:String: String

validateAttributes	back to summary
public void validateAttributes() throws BuildException Validate attributes provided for this task in .xml build file. Exceptions BuildException: if any supplied attribute is invalid or any mandatory attribute is missing.

validateAttributes

back to summary

public void validateAttributes() throws BuildException

Validate attributes provided for this task in .xml build file.

Exceptions

BuildException:: if any supplied attribute is invalid or any mandatory attribute is missing.

validateReplacefilters	back to summary
public void validateReplacefilters() throws BuildException Validate nested elements. Exceptions BuildException: if any supplied attribute is invalid or any mandatory attribute is missing.

validateReplacefilters

back to summary

public void validateReplacefilters() throws BuildException

Validate nested elements.

Exceptions

BuildException:: if any supplied attribute is invalid or any mandatory attribute is missing.

org.apache.tools.ant.taskdefs back to summary

private Class Replace.FileInput

Class Inheritance

extends Object
implements AutoCloseable

java.lang.Object
org.apache.tools.ant.taskdefs.Replace.FileInput

All Implemented Interfaces

java.lang.AutoCloseable

Class reading a file in small chunks, and presenting these chunks in a StringBuffer. Compatible with the Replacefilter.

Since: 1.7

Field Summary

Modifier and Type	Field and Description
private static final int	BUFF_SIZE
private char[]	buffer
private final InputStream	is
private StringBuffer	outputBuffer
private Reader	reader

Constructor Summary

Access	Constructor and Description
pack-priv	FileInput(File The file to read from. source) Constructs the input component.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.lang.AutoCloseable.close. Closes the file.
pack-priv StringBuffer	Returns: The StringBuffer containing the output of this filter. getOutputBuffer() Retrieves the output buffer of this filter.
pack-priv boolean	Returns: true when the end of the file has not been reached. readChunk() Reads some data from the file.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BUFF_SIZE	back to summary
private static final int BUFF_SIZE

buffer	back to summary
private char[] buffer

is	back to summary
private final InputStream is

outputBuffer	back to summary
private StringBuffer outputBuffer

reader	back to summary
private Reader reader

Constructor Detail

FileInput

back to summary

pack-priv FileInput(File source) throws IOException

Constructs the input component. Opens the file for reading.

Parameters

source:File: The file to read from.

Exceptions

IOException:: When the file cannot be read from.

Method Detail

back to summary

public void close() throws IOException

Implements java.lang.AutoCloseable.close.

Closes the file.

Annotations

@Override

Exceptions

IOException:: When the file cannot be closed.

getOutputBuffer

back to summary

pack-priv StringBuffer getOutputBuffer()

Retrieves the output buffer of this filter. The component guarantees that data is only appended to the end of this StringBuffer.

Returns:StringBuffer: The StringBuffer containing the output of this filter.

readChunk

back to summary

pack-priv boolean readChunk() throws IOException

Reads some data from the file.

Returns:boolean

true when the end of the file has not been reached.

Exceptions

IOException:: When the file cannot be read from.

org.apache.tools.ant.taskdefs back to summary

private Class Replace.FileOutput

Class Inheritance

extends Object
implements AutoCloseable

java.lang.Object
org.apache.tools.ant.taskdefs.Replace.FileOutput

All Implemented Interfaces

java.lang.AutoCloseable

Component writing a file in chunks, taking the chunks from the Replacefilter.

Since: 1.7

Field Summary

Modifier and Type	Field and Description
private StringBuffer	inputBuffer
private final OutputStream	os
private Writer	writer

Constructor Summary

Access	Constructor and Description
pack-priv	FileOutput(File The file to read to. out) Constructs the output component.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.lang.AutoCloseable.close. Closes the file.
pack-priv void	flush() Processes the buffer to the end.
pack-priv boolean	Returns: false to be inline with the Replacefilter. (Yes defining an interface crossed my mind, but would publish the internal behavior.) process() Writes the buffer as far as possible.
pack-priv void	setInputBuffer(StringBuffer The input for this filter. input) Sets the input buffer for this component.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

inputBuffer	back to summary
private StringBuffer inputBuffer

os	back to summary
private final OutputStream os

writer	back to summary
private Writer writer

Constructor Detail

FileOutput

back to summary

pack-priv FileOutput(File out) throws IOException

Constructs the output component. Opens the file for writing.

Parameters

out:File: The file to read to.

Exceptions

IOException:: When the file cannot be read from.

Method Detail

back to summary

public void close() throws IOException

Implements java.lang.AutoCloseable.close.

Closes the file.

Annotations

@Override

Exceptions

IOException:: When the file cannot be closed.

flush

back to summary

pack-priv void flush() throws IOException

Processes the buffer to the end.

Exceptions

IOException:: when the output cannot be flushed.

process

back to summary

pack-priv boolean process() throws IOException

Writes the buffer as far as possible.

Returns:boolean

false to be inline with the Replacefilter. (Yes defining an interface crossed my mind, but would publish the internal behavior.)

Exceptions

IOException:: when the output cannot be written.

setInputBuffer

back to summary

pack-priv void setInputBuffer(StringBuffer input)

Sets the input buffer for this component. The filter expects from the component providing the input that data is only added by that component to the end of this StringBuffer. This StringBuffer will be modified by this filter, and expects that another component will only append to this StringBuffer.

Parameters

input:StringBuffer: The input for this filter.

org.apache.tools.ant.taskdefs back to summary

public Class Replace.NestedString

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.taskdefs.Replace.NestedString

An inline string to use as the replacement text.

Field Summary

Modifier and Type	Field and Description
private StringBuffer	buf
private boolean	expandProperties

Constructor Summary

Access	Constructor and Description
public	NestedString()

Method Summary

Modifier and Type	Method and Description
public void	addText(String the string to add val) The text of the element.
public String	Returns: the text getText()
public void	setExpandProperties(boolean boolean b) Whether properties should be expanded in nested test.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buf	back to summary
private StringBuffer buf

expandProperties	back to summary
private boolean expandProperties

Constructor Detail

NestedString	back to summary
public NestedString()

Method Detail

addText

back to summary

public void addText(String val)

The text of the element.

Parameters

val:String: the string to add

getText	back to summary
public String getText() Returns:String the text

setExpandProperties back to summary

public void setExpandProperties(boolean b)

Whether properties should be expanded in nested test.

If you use this class via its Java interface the text you add via addText has most likely been expanded already so you do not want to set this to true.

Parameters

b:boolean: boolean

Since

Ant 1.8.0

org.apache.tools.ant.taskdefs back to summary

public Class Replace.Replacefilter

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.taskdefs.Replace.Replacefilter

A filter to apply.

Field Summary

Modifier and Type	Field and Description
private StringBuffer	inputBuffer
private StringBuffer	outputBuffer
private String	property
private String	replaceValue
private Replace.NestedString	token
private Replace.NestedString	value

Constructor Summary

Access	Constructor and Description
public	Replacefilter()

Method Summary

Modifier and Type	Method and Description
public Replace.NestedString	Returns: nested token `NestedString` to configure. createReplaceToken() Create a token to filter as the text of a nested element.
public Replace.NestedString	Returns: replacement value `NestedString` to configure. createReplaceValue() Create a string to replace the token as the text of a nested element.
pack-priv void	flush() Processes the buffer to the end.
pack-priv StringBuffer	Returns: The StringBuffer containing the output of this filter. getOutputBuffer() Retrieves the output buffer of this filter.
public String	Returns: property or null. getProperty() Get the name of the property whose value is to serve as the replacement value.
public String	Returns: the replacement value getReplaceValue() Get the replacement value for this filter token.
public String	Returns: current `String` token. getToken() Get the string to search for.
public String	Returns: replacement or null. getValue() Get replacement `String`.
pack-priv boolean	Returns: true if some data has been made available in the output buffer. process() Processes the buffer as far as possible.
private int	Returns: The position of the last character that was inserted as replacement. replace() Performs the replace operation.
pack-priv void	setInputBuffer(StringBuffer The input for this filter. input) Sets the input buffer for this filter.
public void	setProperty(String property name. property) Set the name of the property whose value is to serve as the replacement value; required if `value` is not set.
public void	setToken(String `String` token. t) Set the token to replace.
public void	setValue(String `String` value to replace. value) The replacement string; required if `property` is not set.
public void	validate() Validate the filter's configuration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

inputBuffer	back to summary
private StringBuffer inputBuffer

outputBuffer	back to summary
private StringBuffer outputBuffer

property	back to summary
private String property

replaceValue	back to summary
private String replaceValue

token	back to summary
private Replace.NestedString token

value	back to summary
private Replace.NestedString value

Constructor Detail

Replacefilter	back to summary
public Replacefilter()

Method Detail

createReplaceToken back to summary

public Replace.NestedString createReplaceToken()

Create a token to filter as the text of a nested element.

Returns:Replace.NestedString: nested token NestedString to configure.
Since: Ant 1.8.0

createReplaceValue back to summary

public Replace.NestedString createReplaceValue()

Create a string to replace the token as the text of a nested element.

Returns:Replace.NestedString: replacement value NestedString to configure.
Since: Ant 1.8.0

flush	back to summary
pack-priv void flush() Processes the buffer to the end. Does not take into account that appended data may make it possible to replace the end of the already received data.

getOutputBuffer

back to summary

pack-priv StringBuffer getOutputBuffer()

Retrieves the output buffer of this filter. The filter guarantees that data is only appended to the end of this StringBuffer.

Returns:StringBuffer: The StringBuffer containing the output of this filter.

getProperty

back to summary

public String getProperty()

Get the name of the property whose value is to serve as the replacement value.

Returns:String: property or null.

getReplaceValue

back to summary

public String getReplaceValue()

Get the replacement value for this filter token.

Returns:String: the replacement value

getToken back to summary

public String getToken()

Get the string to search for.

Returns:String: current String token.

getValue back to summary

public String getValue()

Get replacement String.

Returns:String: replacement or null.

process

back to summary

pack-priv boolean process()

Processes the buffer as far as possible. Takes into account that appended data may make it possible to replace the end of the already received data, when the token is split over the "old" and the "new" part.

Returns:boolean: true if some data has been made available in the output buffer.

replace

back to summary

private int replace()

Performs the replace operation.

Returns:int: The position of the last character that was inserted as replacement.

setInputBuffer

back to summary

pack-priv void setInputBuffer(StringBuffer input)

Sets the input buffer for this filter. The filter expects from the component providing the input that data is only added by that component to the end of this StringBuffer. This StringBuffer will be modified by this filter, and expects that another component will only append to this StringBuffer.

Parameters

input:StringBuffer: The input for this filter.

setProperty back to summary

public void setProperty(String property)

Set the name of the property whose value is to serve as the replacement value; required if value is not set.

Parameters

property:String: property name.

setToken back to summary

public void setToken(String t)

Set the token to replace.

Parameters

t:String: String token.

setValue back to summary

public void setValue(String value)

The replacement string; required if property is not set.

Parameters

value:String: String value to replace.

validate

back to summary

public void validate() throws BuildException

Validate the filter's configuration.

Exceptions

BuildException:: if any part is invalid.

public Class Replace

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Replace.FileInput

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Replace.FileOutput

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Replace.NestedString

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Replace.Replacefilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail