org.apache.tools.ant.taskdefs

Class Echo

public class Echo extends Task

Writes a message to the Ant logging facilities.

Since: Ant 1.1

UNKNOWN: category="utility"

Nested Class Summary
static class	Echo.EchoLevel The enumerated values for the level attribute.

Field Summary
protected boolean	append
protected File	file
protected int	logLevel
protected String	message

Method Summary
void	addText(String msg) Set a multiline message.
void	execute() Does the work.
void	setAppend(boolean append) If true, append to existing file.
void	setEncoding(String encoding) Declare the encoding to use when outputting to a file; Use "" for the platform's default encoding.
void	setFile(File file) File to write to.
void	setLevel(Echo.EchoLevel echoLevel) Set the logging level.
void	setMessage(String msg) Message to write.

Field Detail

append

protected boolean append

file

protected File file

logLevel

protected int logLevel

message

protected String message

Method Detail

addText

public void addText(String msg)

Set a multiline message.

Parameters: msg the CDATA text to append to the output text

execute

public void execute()

Does the work.

Throws: BuildException if something goes wrong with the build

setAppend

public void setAppend(boolean append)

If true, append to existing file.

Parameters: append if true, append to existing file, default is false.

setEncoding

public void setEncoding(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

setFile

public void setFile(File file)

File to write to.

Parameters: file the file to write to, if not set, echo to standard output

setLevel

public 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

setMessage

public void setMessage(String msg)

Message to write.

Parameters: msg Sets the value for the message variable.