org.apache.tools.ant

Class 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.

Constructor Summary

BuildEvent(Project project)
Construct a BuildEvent for a project level event.
BuildEvent(Target target)
Construct a BuildEvent for a target level event.
BuildEvent(Task task)
Construct a BuildEvent for a task level event.

Method Summary

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.

Constructor Details

BuildEvent

public BuildEvent(Project project)
Construct a BuildEvent for a project level event.
Parameters:
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.
Parameters:
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.
Parameters:
task - the task that emitted the event. Must not be null.

Method Details

getException

public Throwable getException()
Returns the exception that was thrown, if any. This field will only be set for "taskFinished", "targetFinished", and "buildFinished" events.
Returns:
the exception associated with this exception, or null if no exception has been set.

getMessage

public String getMessage()
Returns the logging message. This field will only be set for "messageLogged" events.
Returns:
the message associated with this event, or null if no message has been set.

getPriority

public int getPriority()
Returns:
the priority associated with this event.

getProject

public Project getProject()
Returns the project that fired this event.
Returns:
the project that fired this event

getTarget

public Target getTarget()
Returns the target that fired this event.
Returns:
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.
Returns:
the task that fired this event, or null if this event is a project or target level event.

setException

public void setException(Throwable exception)
Sets the exception associated with this event. This is used for "taskFinished", "targetFinished", and "buildFinished" events.
Parameters:
exception - The exception to be associated with this event. May be null.

setMessage

public void setMessage(String message,
                       int priority)
Sets the message and priority associated with this event. This is used for "messageLogged" events.

Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.