Mobile Tools for Java
Release 1.0

org.eclipse.mtj.core.build
Interface IMTJBuildHook


public interface IMTJBuildHook

IMTJBuildHook Interface provides a way for third party components to hook themselves to the MTJ project's build process. The build process has several states and the hook is called upon every state transition in order to eventually do some action.
NOTE: The hook callback must return as soon as it ends its action if any, so it won't represent an overhead to the build process.

Since:
1.0

Method Summary
 void buildStateChanged(IMTJProject project, MTJBuildState state, IProgressMonitor monitor)
          This method is called upon state transitions within the MTJ build process.
 

Method Detail

buildStateChanged

void buildStateChanged(IMTJProject project,
                       MTJBuildState state,
                       IProgressMonitor monitor)
                       throws CoreException
This method is called upon state transitions within the MTJ build process. This method implementation must be lightweight in order to avoid introducing overhead to the build process. In case the hook has nothing to do on the new state it must return as soon as possible.

The project instance passed during the invocation of this method provides everything a build hook might require, including access to all resources available.

A progress monitor is provided to report in the user interface the current statuses inside the hook.
Note: Progress messages should be "user readable" to be displayed in the User Interface.

In case an error has occurred, clients implementing this interface must throw a CoreException that will be treated by MTJ and correctly displayed.
Note: Exception messages should be "user readable" to be displayed in the User Interface.

Parameters:
project - the IMTJProject being built.
state - new build state. For more info on available build states see MTJBuildState.
monitor - a progress monitor.
Throws:
CoreException - any error occurred.
See Also:
MTJBuildState

Mobile Tools for Java
Release 1.0