public interface BuildListener
extends java.util.EventListener
BuildSystem
events by
implementing this interface and registering their build listener with the
extension deployment descriptor.
IDE providers are responsible for calling the BuildListener
methods before their compiler starts compiling documents and immediately
after it finishes doing so.
Modifier and Type | Method and Description |
---|---|
void |
postBuild(BuildEvent event)
When the compiler finishes compiling documents, the
postBuild methods are called. |
void |
preBuild(BuildEvent event)
The
preBuild method is called before documents are compiled. |
void preBuild(BuildEvent event) throws AbortBuildException
preBuild
method is called before documents are compiled.
If a listener throws an AbortBuildException
, the entire build is
aborted and the postBuild
methods are called immediately on
the listeners whose preBuild
method had a chance to
execute (incuding the one that aborted the build).
The postBuild
method is not called on listener
that did not execute their preBuild
method.
This method may be called from threads other than the AWT event thread.
event
- the build event.AbortBuildException
- to abort the entire build.void postBuild(BuildEvent event) throws AbortBuildException
postBuild
methods are called. If any postBuild
method throws an AbortBuildException
, the postBuild
methods are still called on the remaining listeners. Implementors of the
postBuild
method must always check the
BuildEvent.isBuildSuccessful()
method before continuing.
This method may be called from threads other than the AWT event thread.
event
- the build event.AbortBuildException
- to abort the entire build.