org.apache.tools.ant
Class BuildEvent
EventObject
org.apache.tools.ant.BuildEvent
public class BuildEvent
extends EventObject
Class representing an event occurring during a build. An
event is built by specifying either a project, a task or a target.
A project level event will only have a project reference;
a target level event will have project and target references;
a task level event will have project, target and task references.
Throwable | getException() - Returns the exception that was thrown, if any.
|
String | getMessage() - Returns the logging message.
|
int | getPriority() - Returns the priority of the logging message.
|
Project | getProject() - Returns the project that fired this event.
|
Target | getTarget() - Returns the target that fired this event.
|
Task | getTask() - Returns the task that fired this event.
|
void | setException(Throwable exception) - Sets the exception associated with this event.
|
void | setMessage(String message, int priority) - Sets the message and priority associated with this event.
|
BuildEvent
public BuildEvent(Project project)
Construct a BuildEvent for a project level event.
project
- the project that emitted the event.
Should not be null
.
BuildEvent
public BuildEvent(Target target)
Construct a BuildEvent for a target level event.
The project associated with the event is derived
from the given target.
target
- the target that emitted the event.
Must not be null
.
BuildEvent
public BuildEvent(Task task)
Construct a BuildEvent for a task level event.
The project and target associated with the event
are derived from the given task.
task
- the task that emitted the event.
Must not be null
.
getMessage
public String getMessage()
Returns the logging message. This field will only be set
for "messageLogged" events.
- the message associated with this event, or
null
if no message has been set.
BuildListener.messageLogged(BuildEvent)
getPriority
public int getPriority()
Returns the priority of the logging message. This field will only
be set for "messageLogged" events. The meaning of this priority
is as specified by the constants in the
Project
class.
- the priority associated with this event.
BuildListener.messageLogged(BuildEvent)
getProject
public Project getProject()
Returns the project that fired this event.
- the project that fired this event
getTarget
public Target getTarget()
Returns the target that fired this event.
- the project that fired this event, or
null
if this event is a project level event.
getTask
public Task getTask()
Returns the task that fired this event.
- the task that fired this event, or
null
if this event is a project or target level event.
setMessage
public void setMessage(String message,
int priority)
Sets the message and priority associated with this event.
This is used for "messageLogged" events.
message
- the message to be associated with this event.
Should not be null
.priority
- the priority to be associated with this event,
as defined in the Project
class.
BuildListener.messageLogged(BuildEvent)
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.