Package org.apache.tools.ant.taskdefs
Class Echo
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.Echo
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable
 
 public class Echo extends Task Writes a message to the Ant logging facilities.- Since:
- Ant 1.1
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classEcho.EchoLevelThe enumerated values for the level attribute.
 - 
Field SummaryFields Modifier and Type Field Description protected booleanappendprotected java.io.Filefileprotected intlogLevelprotected java.lang.Stringmessage- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description Echo()
 - 
Method SummaryModifier and Type Method Description voidaddText(java.lang.String msg)Set a multiline message.voidexecute()Does the work.voidsetAppend(boolean append)If true, append to existing file.voidsetEncoding(java.lang.String encoding)Declare the encoding to use when outputting to a file; Use "" for the platform's default encoding.voidsetFile(java.io.File file)File to write to.voidsetForce(boolean f)Whether read-only destinations will be overwritten.voidsetLevel(Echo.EchoLevel echoLevel)Set the logging level.voidsetMessage(java.lang.String msg)Message to write.voidsetOutput(Resource output)Resource to write to.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Method Detail- 
executepublic void execute() throws BuildExceptionDoes the work.- Overrides:
- executein class- Task
- Throws:
- BuildException- if something goes wrong with the build
 
 - 
setMessagepublic void setMessage(java.lang.String msg) Message to write.- Parameters:
- msg- Sets the value for the message variable.
 
 - 
setFilepublic void setFile(java.io.File file) File to write to.- Parameters:
- file- the file to write to, if not set, echo to standard output
 
 - 
setOutputpublic void setOutput(Resource output) Resource to write to.- Parameters:
- output- the Resource to write to.
- Since:
- Ant 1.8
 
 - 
setAppendpublic void setAppend(boolean append) If true, append to existing file.- Parameters:
- append- if true, append to existing file, default is false.
 
 - 
addTextpublic void addText(java.lang.String msg) Set a multiline message.- Parameters:
- msg- the CDATA text to append to the output text
 
 - 
setLevelpublic void setLevel(Echo.EchoLevel echoLevel) Set the logging level. Level should be one of- error
- warning
- info
- verbose
- debug
 The default is "warning" to ensure that messages are displayed by default when using the -quiet command line option. - Parameters:
- echoLevel- the logging level
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) Declare the encoding to use when outputting to a file; Use "" for the platform's default encoding.- Parameters:
- encoding- the character encoding to use.
- Since:
- 1.7
 
 - 
setForcepublic void setForce(boolean f) Whether read-only destinations will be overwritten.Defaults to false - Parameters:
- f- boolean
- Since:
- Ant 1.8.2
 
 
- 
 
-