Package org.apache.tools.ant
Class BuildEvent
java.lang.Object
java.util.EventObject
org.apache.tools.ant.BuildEvent
- All Implemented Interfaces:
Serializable
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.
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionBuildEvent
(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
Modifier and TypeMethodDescriptionReturns the exception that was thrown, if any.Returns the logging message.int
Returns the priority of the logging message.Returns the project that fired this event.Returns the target that fired this event.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.Methods inherited from class java.util.EventObject
getSource, toString
-
Constructor Details
-
BuildEvent
Construct a BuildEvent for a project level event.- Parameters:
project
- the project that emitted the event. Should not benull
.
-
BuildEvent
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 benull
.
-
BuildEvent
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 benull
.
-
-
Method Details
-
setMessage
Sets the message and priority associated with this event. This is used for "messageLogged" events.- Parameters:
message
- the message to be associated with this event. Should not benull
.priority
- the priority to be associated with this event, as defined in theProject
class.- See Also:
-
setException
Sets the exception associated with this event. This is used for "messageLogged", "taskFinished", "targetFinished", and "buildFinished" events.- Parameters:
exception
- The exception to be associated with this event. May benull
.- See Also:
-
getProject
Returns the project that fired this event.- Returns:
- the project that fired this event
-
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
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.
-
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. - See Also:
-
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 theProject
class.- Returns:
- the priority associated with this event.
- See Also:
-
getException
Returns the exception that was thrown, if any. This field will only be set for "messageLogged", "taskFinished", "targetFinished", and "buildFinished" events.- Returns:
- the exception associated with this exception, or
null
if no exception has been set. - See Also:
-