| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Echo
public class Echo
Writes a message to the Ant logging facilities.
| Nested Class Summary | |
|---|---|
| static class | Echo.EchoLevelThe enumerated values for the level attribute. | 
| Field Summary | |
|---|---|
| protected  boolean | append | 
| protected  java.io.File | file | 
| protected  int | logLevel | 
| protected  java.lang.String | message | 
| 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 | 
| Constructor Summary | |
|---|---|
| Echo() | |
| Method Summary | |
|---|---|
|  void | addText(java.lang.String msg)Set a multiline message. | 
|  void | execute()Does the work. | 
|  void | setAppend(boolean append)If true, append to existing file. | 
|  void | setEncoding(java.lang.String encoding)Declare the encoding to use when outputting to a file; Use "" for the platform's default encoding. | 
|  void | setFile(java.io.File file)File to write to. | 
|  void | setForce(boolean f)Whether read-only destinations will be overwritten. | 
|  void | setLevel(Echo.EchoLevel echoLevel)Set the logging level. | 
|  void | setMessage(java.lang.String msg)Message to write. | 
|  void | setOutput(Resource output)Resource to write to. | 
| Methods inherited from class org.apache.tools.ant.Task | 
|---|
| bindToOwner, 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, setDescription, setLocation, setProject | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
protected java.lang.String message
protected java.io.File file
protected boolean append
protected int logLevel
| Constructor Detail | 
|---|
public Echo()
| Method Detail | 
|---|
public void execute()
             throws BuildException
execute in class TaskBuildException - if something goes wrong with the buildpublic void setMessage(java.lang.String msg)
msg - Sets the value for the message variable.public void setFile(java.io.File file)
file - the file to write to, if not set, echo to
             standard outputpublic void setOutput(Resource output)
output - the Resource to write to.public void setAppend(boolean append)
append - if true, append to existing file, default
               is false.public void addText(java.lang.String msg)
msg - the CDATA text to append to the output textpublic void setLevel(Echo.EchoLevel echoLevel)
The default is "warning" to ensure that messages are displayed by default when using the -quiet command line option.
echoLevel - the logging levelpublic void setEncoding(java.lang.String encoding)
encoding - the character encoding to use.public void setForce(boolean f)
Defaults to false
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||