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:
- Cloneable
Writes a message to the Ant logging facilities.
- Since:
- Ant 1.1
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classThe enumerated values for the level attribute.
- 
Field SummaryFieldsFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidSet a multiline message.voidexecute()Does the work.voidsetAppend(boolean append) If true, append to existing file.voidsetEncoding(String encoding) Declare the encoding to use when outputting to a file; Use "" for the platform's default encoding.voidFile to write to.voidsetForce(boolean f) Whether read-only destinations will be overwritten.voidsetLevel(Echo.EchoLevel echoLevel) Set the logging level.voidsetMessage(String msg) Message to write.voidResource 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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Field Details- 
message
- 
file
- 
appendprotected boolean append
- 
logLevelprotected int logLevel
 
- 
- 
Constructor Details- 
Echopublic Echo()
 
- 
- 
Method Details- 
executeDoes the work.- Overrides:
- executein class- Task
- Throws:
- BuildException- if something goes wrong with the build
 
- 
setMessageMessage to write.- Parameters:
- msg- Sets the value for the message variable.
 
- 
setFileFile to write to.- Parameters:
- file- the file to write to, if not set, echo to standard output
 
- 
setOutputResource 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.
 
- 
addTextSet a multiline message.- Parameters:
- msg- the CDATA text to append to the output text
 
- 
setLevelSet 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
 
- 
setEncodingDeclare 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
 
 
-