|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.util.EventObject
org.apache.tools.ant.BuildEvent
public class BuildEvent
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.
| Field Summary |
|---|
| Fields inherited from class java.util.EventObject |
|---|
source |
| 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 | |
|---|---|
java.lang.Throwable |
getException()
Returns the exception that was thrown, if any. |
java.lang.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(java.lang.Throwable exception)
Sets the exception associated with this event. |
void |
setMessage(java.lang.String message,
int priority)
Sets the message and priority associated with this event. |
| Methods inherited from class java.util.EventObject |
|---|
getSource, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BuildEvent(Project project)
project - the project that emitted the event.
Should not be null.public BuildEvent(Target target)
target - the target that emitted the event.
Must not be null.public BuildEvent(Task task)
task - the task that emitted the event.
Must not be null.| Method Detail |
|---|
public void setMessage(java.lang.String message,
int priority)
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)public void setException(java.lang.Throwable exception)
exception - The exception to be associated with this event.
May be null.BuildListener.messageLogged(BuildEvent),
BuildListener.taskFinished(BuildEvent),
BuildListener.targetFinished(BuildEvent),
BuildListener.buildFinished(BuildEvent)public Project getProject()
public Target getTarget()
null
if this event is a project level event.public Task getTask()
null
if this event is a project or target level event.public java.lang.String getMessage()
null
if no message has been set.BuildListener.messageLogged(BuildEvent)public int getPriority()
Project class.
BuildListener.messageLogged(BuildEvent)public java.lang.Throwable getException()
null if no exception has been set.BuildListener.messageLogged(BuildEvent),
BuildListener.taskFinished(BuildEvent),
BuildListener.targetFinished(BuildEvent),
BuildListener.buildFinished(BuildEvent)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||