BuildListener (Apache Ant API)

org.apache.tools.ant
Interface BuildListener

All Superinterfaces:
java.util.EventListener
All Known Subinterfaces:
BuildLogger
All Known Implementing Classes:
AntClassLoader, AntSoundPlayer, CommonsLoggingListener, DefaultLogger, IntrospectionHelper, Log4jListener, RecorderEntry, XmlLogger

public interface BuildListener
extends java.util.EventListener

Instances of classes that implement this interface can register to be notified when things happened during a build.

Author:
Matt Foemmel
See Also:
BuildEvent, Project.addBuildListener(BuildListener)

Method Summary
 void buildFinished(BuildEvent event)
          Signals that the last target has finished.
 void buildStarted(BuildEvent event)
          Signals that a build has started.
 void messageLogged(BuildEvent event)
          Signals a message logging event.
 void targetFinished(BuildEvent event)
          Signals that a target has finished.
 void targetStarted(BuildEvent event)
          Signals that a target is starting.
 void taskFinished(BuildEvent event)
          Signals that a task has finished.
 void taskStarted(BuildEvent event)
          Signals that a task is starting.
 

Method Detail

buildStarted


public void buildStarted(BuildEvent event)
Signals that a build has started. This event is fired before any targets have started.

Parameters:
event - An event with any relevant extra information. Must not be null.

buildFinished


public void buildFinished(BuildEvent event)
Signals that the last target has finished. This event will still be fired if an error occurred during the build.

Parameters:
event - An event with any relevant extra information. Must not be null.
See Also:
BuildEvent.getException()

targetStarted


public void targetStarted(BuildEvent event)
Signals that a target is starting.

Parameters:
event - An event with any relevant extra information. Must not be null.
See Also:
BuildEvent.getTarget()

targetFinished


public void targetFinished(BuildEvent event)
Signals that a target has finished. This event will still be fired if an error occurred during the build.

Parameters:
event - An event with any relevant extra information. Must not be null.
See Also:
BuildEvent.getException()

taskStarted


public void taskStarted(BuildEvent event)
Signals that a task is starting.

Parameters:
event - An event with any relevant extra information. Must not be null.
See Also:
BuildEvent.getTask()

taskFinished


public void taskFinished(BuildEvent event)
Signals that a task has finished. This event will still be fired if an error occurred during the build.

Parameters:
event - An event with any relevant extra information. Must not be null.
See Also:
BuildEvent.getException()

messageLogged


public void messageLogged(BuildEvent event)
Signals a message logging event.

Parameters:
event - An event with any relevant extra information. Must not be null.
See Also:
BuildEvent.getMessage(), BuildEvent.getPriority()


Copyright 2000-2002 Apache Software Foundation. All Rights Reserved.