javax.ide.build

Class BuildSystem

java.lang.Object

javax.ide.Service

javax.ide.build.BuildSystem

public abstract class BuildSystem
extends Service

The BuildSystem service allows extension writers to initiate a build and query information from the build system.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuildSystem()

Method Summary

Modifier and Type	Method and Description
void	addBuildListener(BuildListener l) Add an BuildListener.
abstract void	build(Context context) Start a build of the objects selected in the Context.
static BuildSystem	getBuildSystem() Gets the build system implementation.
protected java.util.Collection	getListeners() Get all listeners.
protected boolean	hasListeners() Get whether there are any registered listeners.
protected void	initialize() Initializes the build system manager.
abstract boolean	isBuilding() Check if the build system is currently building something.
void	removeBuildListener(BuildListener l) Remove an BuildListener.

Methods inherited from class javax.ide.Service

cloneLoadedServices, getService, resetAllServices, setLoadedServices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildSystem

protected BuildSystem()

Method Detail

hasListeners

protected final boolean hasListeners()

Get whether there are any registered listeners.

Returns:

true if there are any registered listeners.

getListeners

protected final java.util.Collection getListeners()

Get all listeners. This method returns an immutable copy of the listener list, so it's safe to iterate this and fire events directly.

Returns:

all listeners.

initialize

protected void initialize()

Initializes the build system manager.

This implementation retrieves and registers listeners obtained from the build system hook handler.

Overrides:

initialize in class Service

addBuildListener

public final void addBuildListener(BuildListener l)

Add an BuildListener.

Parameters:

l - the BuildListener to add.

removeBuildListener

public final void removeBuildListener(BuildListener l)

Remove an BuildListener.

Parameters:

l - The BuildListener to remove.

build

public abstract void build(Context context)

Start a build of the objects selected in the Context. This method starts the build in another thread and returns immediately.

Parameters:

context - the objects returned by calling the Context.getSelection() method are build using the classpath and source path information provided by the context project.

isBuilding

public abstract boolean isBuilding()

Check if the build system is currently building something.

Returns:

true is a build is in progress.

getBuildSystem

public static BuildSystem getBuildSystem()

Gets the build system implementation.

Returns:

the build system implementation for this IDE. Must not return null.