Package org.apache.tools.ant.types
Class RedirectorElement
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.RedirectorElement
- All Implemented Interfaces:
- Cloneable
Element representation of a 
Redirector.- Since:
- Ant 1.6.2
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddConfiguredErrorMapper(Mapper errorMapper) Add the error file mapper.voidaddConfiguredInputMapper(Mapper inputMapper) Add the input file mapper.voidaddConfiguredOutputMapper(Mapper outputMapper) Add the output file mapper.voidconfigure(Redirector redirector) Configure the specifiedRedirector.voidconfigure(Redirector redirector, String sourcefile) Configure the specifiedRedirectorfor the specified sourcefile.Create a nested errorFilterChain.Create a nested inputFilterChain.protected MappercreateMergeMapper(File destfile) Create a merge mapper pointing to the specified destination file.Create a nested outputFilterChain.protected voiddieOnCircularReference(Stack<Object> stk, Project p) Overrides the version of DataType to recurse on all DataType child elements that may have been added.voidsetAlwaysLog(boolean alwaysLog) If true, (error and non-error) output will be "teed", redirected as specified while being sent to Ant's logging mechanism as if no redirection had taken place.voidsetAppend(boolean append) Whether output should be appended to or overwrite an existing file.voidsetBinaryOutput(boolean b) Whether to consider the output created by the process binary.voidsetCreateEmptyFiles(boolean createEmptyFiles) Whether output and error files should be created even when empty.voidSet the file to which standard error is to be redirected.voidsetErrorEncoding(String errorEncoding) Set the error encoding.voidsetErrorProperty(String errorProperty) Property name whose value should be set to the error of the process.voidSet the input to use for the task.voidsetInputEncoding(String inputEncoding) Set the input encoding.voidsetInputString(String inputString) Set the string to use as inputvoidsetLogError(boolean logError) Controls whether error output of exec is logged.voidsetLogInputString(boolean logInputString) Set whether to include the value of the input string in log messages.voidFile the output of the process is redirected to.voidsetOutputEncoding(String outputEncoding) Set the output encoding.voidsetOutputProperty(String outputProperty) Property name whose value should be set to the output of the process.voidMake this instance in effect a reference to another instance.protected File[]toFileArray(String[] name) Return aFile[]from the specified set of filenames.Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
- 
Constructor Details- 
RedirectorElementpublic RedirectorElement()
 
- 
- 
Method Details- 
addConfiguredInputMapperAdd the input file mapper.- Parameters:
- inputMapper-- Mapper.
 
- 
addConfiguredOutputMapperAdd the output file mapper.- Parameters:
- outputMapper-- Mapper.
 
- 
addConfiguredErrorMapperAdd the error file mapper.- Parameters:
- errorMapper-- Mapper.
 
- 
setRefidMake this instance in effect a reference to another instance.You must not set another attribute or nest elements inside this element if you make it a reference. - Overrides:
- setRefidin class- DataType
- Parameters:
- r- the reference to use.
- Throws:
- BuildException- on error.
 
- 
setInputSet the input to use for the task.- Parameters:
- input- the file from which input is read.
 
- 
setInputStringSet the string to use as input- Parameters:
- inputString- the string which is used as the input source
 
- 
setLogInputStringpublic void setLogInputString(boolean logInputString) Set whether to include the value of the input string in log messages. Defaults to true.- Parameters:
- logInputString- true or false.
- Since:
- Ant 1.7
 
- 
setOutputFile the output of the process is redirected to. If error is not redirected, it too will appear in the output.- Parameters:
- out- the file to which output stream is written.
 
- 
setOutputEncodingSet the output encoding.- Parameters:
- outputEncoding-- String.
 
- 
setErrorEncodingSet the error encoding.- Parameters:
- errorEncoding-- String.
 
- 
setInputEncodingSet the input encoding.- Parameters:
- inputEncoding-- String.
 
- 
setLogErrorpublic void setLogError(boolean logError) Controls whether error output of exec is logged. This is only useful when output is being redirected and error output is desired in the Ant log.- Parameters:
- logError- if true the standard error is sent to the Ant log system and not sent to output.
 
- 
setErrorSet the file to which standard error is to be redirected.- Parameters:
- error- the file to which error is to be written.
 
- 
setOutputPropertyProperty name whose value should be set to the output of the process.- Parameters:
- outputProperty- the name of the property to be set with the task's output.
 
- 
setAppendpublic void setAppend(boolean append) Whether output should be appended to or overwrite an existing file. Defaults to false.- Parameters:
- append- if true output and error streams are appended to their respective files, if specified.
 
- 
setAlwaysLogpublic void setAlwaysLog(boolean alwaysLog) If true, (error and non-error) output will be "teed", redirected as specified while being sent to Ant's logging mechanism as if no redirection had taken place. Defaults to false.- Parameters:
- alwaysLog-- boolean
- Since:
- Ant 1.6.3
 
- 
setCreateEmptyFilespublic void setCreateEmptyFiles(boolean createEmptyFiles) Whether output and error files should be created even when empty. Defaults to true.- Parameters:
- createEmptyFiles-- boolean.
 
- 
setErrorPropertyProperty name whose value should be set to the error of the process.- Parameters:
- errorProperty- the name of the property to be set with the error output.
 
- 
createInputFilterChainCreate a nested inputFilterChain.- Returns:
- FilterChain.
 
- 
createOutputFilterChainCreate a nested outputFilterChain.- Returns:
- FilterChain.
 
- 
createErrorFilterChainCreate a nested errorFilterChain.- Returns:
- FilterChain.
 
- 
setBinaryOutputpublic void setBinaryOutput(boolean b) Whether to consider the output created by the process binary.Binary output will not be split into lines which may make error and normal output look mixed up when they get written to the same stream. - Parameters:
- b- boolean
- Since:
- 1.9.4
 
- 
configureConfigure the specifiedRedirector.- Parameters:
- redirector-- Redirector.
 
- 
configureConfigure the specifiedRedirectorfor the specified sourcefile.- Parameters:
- redirector-- Redirector.
- sourcefile-- String.
 
- 
createMergeMapperCreate a merge mapper pointing to the specified destination file.- Parameters:
- destfile-- File
- Returns:
- Mapper.
 
- 
toFileArrayReturn aFile[]from the specified set of filenames.- Parameters:
- name-- String[]
- Returns:
- File[].
 
- 
dieOnCircularReferenceOverrides the version of DataType to recurse on all DataType child elements that may have been added.- Overrides:
- dieOnCircularReferencein class- DataType
- Parameters:
- stk- the stack of data types to use (recursively).
- p- the project to use to dereference the references.
- Throws:
- BuildException- on error.
 
 
-