oracle.ide.compiler
Interface Compiler

All Known Implementing Classes:

JCompiler

public interface Compiler

The Compiler interface provides the API to drive the actual build system.

Method Summary

boolean	addBuildSystemListener(BuildSystemListener bsl) addBuildSystemListener method adds a build system listener instance implementation to the build system, see BuildSystemListener for more information.
boolean	addCopyListener(CopyListener cl) addCopyListener method adds a copy listener instance implementation to the build system, see CopyListener for more information.
boolean	compile(Context context, boolean rebuild, boolean wait) compile -- compile the context (may be project, workspace, file, ...) and return true if they are no errors else false.
boolean	compile(Context context, boolean rebuild, boolean wait, boolean save)
LogPage	getErrorLog()
LogPage	getOutputLog() get{Output|Error}Log gets the default compiler output/error log.
boolean	isBusy(Context context)
boolean	lock(Context context, boolean wait) lock/unlock the context (may be project, workspace, file, ...) and return true if the opeartion was successful.
void	logOutMsg(java.lang.String msg) logOutMsg log a message on the default compiler output log
boolean	removeBuildSystemListener(BuildSystemListener bsl) removeBuildSystemListener method removes a build system listener instance implementation from the build system, see BuildSystemListener for more information.
boolean	removeCopyListener(CopyListener cl) removeCopyListener method removes a copy listener instance implementation from the build system, see CopyListener for more information.
boolean	unlock(Context context)

Method Detail

compile

public boolean compile(Context context,
                       boolean rebuild,
                       boolean wait)

compile -- compile the context (may be project, workspace, file, ...) and return true if they are no errors else false. If wait is false, the method will not wait for the compile to terminate and the return value is undefined.

Parameters:

context - -- workspace, project or file to compile

rebuild - -- if true, unconditionally rebuild sources

wait - -- if true, wait for compile to terminate

compile

public boolean compile(Context context,
                       boolean rebuild,
                       boolean wait,
                       boolean save)

isBusy

public boolean isBusy(Context context)

lock

public boolean lock(Context context,
                    boolean wait)

lock/unlock the context (may be project, workspace, file, ...) and return true if the opeartion was successful. If wait is false, the method will not wait for the context to be locked and return false if the context can't be lock else if wait is true, the context compilation will complete before returning true

Parameters:

context - -- workspace, project or file to lock/unlock

wait - -- if true, wait for compilation to terminate

Returns:

true if successful else false

unlock

public boolean unlock(Context context)

addBuildSystemListener

public boolean addBuildSystemListener(BuildSystemListener bsl)

addBuildSystemListener method adds a build system listener instance implementation to the build system, see BuildSystemListener for more information.

Parameters:

bsl - build system listener to add

Returns:

true if properly added, false if the specified bsl is already been added before

removeBuildSystemListener

public boolean removeBuildSystemListener(BuildSystemListener bsl)

removeBuildSystemListener method removes a build system listener instance implementation from the build system, see BuildSystemListener for more information.

Parameters:

bsl - build system listener to remove

Returns:

true if properly removed, false if the specified bsl is not found

addCopyListener

public boolean addCopyListener(CopyListener cl)

addCopyListener method adds a copy listener instance implementation to the build system, see CopyListener for more information.

Parameters:

cl - copy listener to add

Returns:

true if properly added, false if the specified cl is already been added before

removeCopyListener

public boolean removeCopyListener(CopyListener cl)

removeCopyListener method removes a copy listener instance implementation from the build system, see CopyListener for more information.

Parameters:

cl - copy listener to remove

Returns:

true if properly removed, false if the specified cl is not found

getOutputLog

public LogPage getOutputLog()

get{Output|Error}Log gets the default compiler output/error log.

Returns:

the default LogPage

getErrorLog

public LogPage getErrorLog()

logOutMsg

public void logOutMsg(java.lang.String msg)

logOutMsg log a message on the default compiler output log

Parameters:

msg - -- msg to print on the log