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

public class Echo
extends Task

Writes a message to the Ant logging facilities.

Since:

Ant 1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Echo.EchoLevel	The enumerated values for the level attribute.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	append
protected File	file
protected int	logLevel
protected String	message

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
Echo()

Method Summary

Modifier and Type	Method	Description
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	setForce(boolean f)	Whether read-only destinations will be overwritten.
void	setLevel(Echo.EchoLevel echoLevel)	Set the logging level.
void	setMessage(String msg)	Message to write.
void	setOutput(Resource output)	Resource to write to.

Methods inherited from class 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

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

message

protected String message

file

protected File file

append

protected boolean append

logLevel

protected int logLevel

Constructor Details

Echo

public Echo()

Method Details

execute

public void execute()
             throws BuildException

Does the work.

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build

setMessage

public void setMessage(String msg)

Message to write.

Parameters:

msg - Sets the value for the message variable.

setFile

public void setFile(File file)

File to write to.

Parameters:

file - the file to write to, if not set, echo to standard output

setOutput

public void setOutput(Resource output)

Resource to write to.

Parameters:

output - the Resource to write to.

Since:

Ant 1.8

setAppend

public void setAppend(boolean append)

If true, append to existing file.

Parameters:

append - if true, append to existing file, default is false.

addText

public void addText(String msg)

Set a multiline message.

Parameters:

msg - the CDATA text to append to the output text

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

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

setForce

public void setForce(boolean f)

Whether read-only destinations will be overwritten.

Defaults to false

Parameters:

f - boolean

Since:

Ant 1.8.2