javax.ide.build

Class BuildEvent

java.lang.Object

java.util.EventObject

javax.ide.build.BuildEvent

All Implemented Interfaces:

java.io.Serializable

public final class BuildEvent
extends java.util.EventObject

Event object passed to the BuildListeners.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BuildEvent(BuildSystem buildSystem, Context context) Constructor.
BuildEvent(BuildSystem buildSystem, Context context, boolean success) Constructor.

Method Summary

Modifier and Type	Method and Description
BuildSystem	getBuildSystem() Get the BuildSystem where the event happened.
Context	getContext() Get the context currently used to build.
boolean	isBuildSuccessful() Flag indicating if the build was successful.

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

BuildEvent

public BuildEvent(BuildSystem buildSystem,
                  Context context)

Constructor.

Parameters:

buildSystem - the build system where the event happened. Must not be null.

context - the context to build. Must not be null.

BuildEvent

public BuildEvent(BuildSystem buildSystem,
                  Context context,
                  boolean success)

Constructor.

Parameters:

buildSystem - the build system where the event happened. Must not be null.

context - the context to build. Must not be null.

success - true if the build is succeding. false if it failed or was aborted.

Method Detail

getBuildSystem

public BuildSystem getBuildSystem()

Get the BuildSystem where the event happened. This is functionally equivalent to casting the result of getSource() to a BuildSystem object.

Returns:

the BuildSystem that generated the event. Must not be null.

getContext

public Context getContext()

Get the context currently used to build. The context selection lists all documents being built. The context project provides the source and class path.

Returns:

the current context.

isBuildSuccessful

public boolean isBuildSuccessful()

Flag indicating if the build was successful. Implementors must check this flag before proceeding with their pre or post build behavior.

Returns:

true if build is successful. false if the build failed or was aborted.