|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.compiler.Compiler oracle.jdeveloper.compiler.JCompiler
public final class JCompiler
The JCompiler
manages compiling.
Fields inherited from class oracle.ide.compiler.Compiler |
---|
COMPILER_GENERATE_CLASSES_DESPITE_ERRORS |
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 |
canShutdown()
This method is called by the IDE to confirm that the ide can shutdown |
boolean |
clean(Context context,
boolean throwOnFailedDelete,
java.io.OutputStream outStream,
java.io.OutputStream errStream)
Clean the context (may be workspace or project). |
boolean |
compile(CompileArguments compileArguments)
Compile one or more targets using the arguments defined in the CompileArguments object. |
boolean |
compile(Context context,
boolean rebuild,
boolean wait)
Deprecated. Use compile(CompileArguments) instead |
boolean |
compile(Context context,
boolean rebuild,
boolean wait,
boolean save)
Deprecated. Use compile(CompileArguments) instead |
boolean |
compile(Context context,
boolean rebuild,
boolean wait,
java.io.OutputStream outStream,
java.io.OutputStream errStream)
Deprecated. Use compile(CompileArguments) instead |
void |
compile(Context context,
boolean rebuild,
PostBuilder postBuild,
boolean save)
Deprecated. |
int |
compileInThread(java.lang.Thread thread,
Project prj,
java.util.ArrayList files,
boolean rebuild)
compileInThread -- will compile the specified list of classes within the context of an already running compiler thread. |
boolean |
forceRebuildOnProject(Project prj)
|
LogPage |
getErrorLog()
|
static JCompiler |
getInstance()
The Debugger folder is a singleton class. |
static java.util.logging.Logger |
getLogger()
|
LogPage |
getOutputLog()
get{Output|Error}Log gets the default compiler output/error log. |
void |
initialize()
This method is called by the IDE to request that the feature be initialize |
boolean |
internalJavaCompile(Context context,
java.util.ArrayList messages)
internalJavaCompile is an internal use only API used to perform a non-ui java-only compilation. |
boolean |
isBusy(Context context)
Will return true if the build system is already busy building and not currently available. |
boolean |
lock(Context context,
boolean wait)
lock/unlock the context (may be project, workspace, file, ...) and return true if the operation was successful. |
void |
logOutMsg(java.lang.String msg)
logOutMsg log a message on the default compiler output log |
void |
registerNavigable(Navigable navigable)
Registers a Navigable as a child of the Compiler
Navigable in the Project Settings Dialog. |
void |
registerTranslator(Translator translator)
Entry point to register compiler translators |
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. |
void |
shutdown()
This method is called by the IDE to request that the feature release any resources held before the ide shuts down.. |
void |
stopBuild(Context context)
Will attempt to stop the build if one is happening right now. |
boolean |
unlock(Context context)
|
void |
unregisterTranslator(Translator translator)
Entry point to remove compiler translators |
Methods inherited from class oracle.ide.compiler.Compiler |
---|
getCompiler, setCompiler |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DISABLE_FILE_NOT_IN_PROJECT_WARNING
public static final int MAKE_SELECTED_CMD_ID
public static final java.lang.String MAKE_SELECTED_CMD
public static final int BUILD_SELECTED_CMD_ID
public static final java.lang.String BUILD_SELECTED_CMD
public static final int MAKE_WORKINGSET_CMD_ID
public static final java.lang.String MAKE_WORKINGSET_CMD
public static final int BUILD_WORKINGSET_CMD_ID
public static final java.lang.String BUILD_WORKINGSET_CMD
public static final int MAKE_PROJECT_CMD_ID
public static final java.lang.String MAKE_PROJECT_CMD
public static final int MAKE_PROJECT_AND_DEPENDENCIES_CMD_ID
public static final java.lang.String MAKE_PROJECT_AND_DEPENDENCIES_CMD
public static final int BUILD_PROJECT_CMD_ID
public static final java.lang.String BUILD_PROJECT_CMD
public static final int BUILD_PROJECT_AND_DEPENDENCIES_CMD_ID
public static final java.lang.String BUILD_PROJECT_AND_DEPENDENCIES_CMD
public static final int MAKE_WORKSPACE_CMD_ID
public static final java.lang.String MAKE_WORKSPACE_CMD
public static final int BUILD_WORKSPACE_CMD_ID
public static final java.lang.String BUILD_WORKSPACE_CMD
public static final int MAKE_FOLDER_CMD_ID
public static final java.lang.String MAKE_FOLDER_CMD
public static final int CANCEL_BUILD_CMD_ID
public static final java.lang.String CANCEL_BUILD_CMD
public static final int CLEANALL_CMD_ID
public static final java.lang.String CLEANALL_CMD
public static final int CLEAN_PROJECT_CMD_ID
public static final java.lang.String CLEAN_PROJECT_CMD
public static final int CLEAN_WORKSPACE_CMD_ID
public static final java.lang.String CLEAN_WORKSPACE_CMD
Method Detail |
---|
public static JCompiler getInstance()
Debugger
folder is a singleton class. This method
gets this folder's single instance.
Debugger
folder single instance.public boolean forceRebuildOnProject(Project prj)
public void initialize()
initialize
in interface Addin
AddinManager
public void shutdown()
shutdown
in interface ShutdownHook
public boolean canShutdown()
canShutdown
in interface ShutdownHook
public boolean isBusy(Context context)
isBusy
in class Compiler
context
- -- workspace, project or file
public void stopBuild(Context context)
public boolean compile(CompileArguments compileArguments)
compile
in class Compiler
compileArguments
- The arguments that define the compilation
@Deprecated public boolean compile(Context context, boolean rebuild, boolean wait)
compile
in class Compiler
context
- -- workspace, project or file to compilerebuild
- -- if true, unconditionally rebuild sourceswait
- -- if true, wait for compile to terminate
@Deprecated public boolean compile(Context context, boolean rebuild, boolean wait, boolean save)
compile
in class Compiler
context
- -- workspace, project or file to compilerebuild
- -- if true, unconditionally rebuild sourceswait
- -- if true, wait for compile to terminatesave
- -- if true, will save files before compiling if the IDE
setting is enabled; if false, will never save files,
regardless of the IDE setting.
@Deprecated public void compile(Context context, boolean rebuild, PostBuilder postBuild, boolean save)
Compiler
compile
in class Compiler
context
- -- workspace, project or file to compilerebuild
- -- if true, unconditionally rebuild sourcespostBuild
- --method postBuild will be called once the build is
completedsave
- -- if true, will save files before compiling if the IDE
setting is enabled; if false, will never save files,
regardless of the IDE setting. The compile method
without the save parameter will never save files.@Deprecated public boolean compile(Context context, boolean rebuild, boolean wait, java.io.OutputStream outStream, java.io.OutputStream errStream)
compile
in class Compiler
context
- -- workspace, project or file to compilerebuild
- -- if true, unconditionally rebuild sourceswait
- -- if true, wait for compile to terminateoutStream
- -- stream where to log all verbose build system messageserrStream
- -- stream where to log all translators errors/warnings
public boolean clean(Context context, boolean throwOnFailedDelete, java.io.OutputStream outStream, java.io.OutputStream errStream) throws java.io.IOException
clean
in class Compiler
context
- -- workspace or project to cleanthrowOnFailedDelete
- -- if true, throw an IOException if
delete on any file or directory failsoutStream
- -- stream where to log any verbose system message;
if null, stdout will be usederrStream
- -- stream where to log any error/warning;
if null, stderr will be used
java.io.IOException
- if throwOnDeleteFailure is true and delete
on any file or directory fails. Use getMessage to get the
path of the file or directorypublic boolean internalJavaCompile(Context context, java.util.ArrayList messages) throws java.lang.Exception
context
- -- java file(s) to compile as specified in the selection,
the java source nodes don't need to be saved on disk and this API will not
saved them if they aren't, regarless of the tools preference
saveBeforeCompile.messages
- -- output parameter containing the list of one or more
messages produced by the compilation. Each messages are a String and the
format is: "'full_path_name'('lineno','colno'):'error number':'error msg'"
example: "c:\source\Class1.java(5,2):314:unreachable code"
java.lang.IllegalArgumentException
- if one or more element in the selections
are not java files. Also thrown when messages &| context are null.
java.lang.ClassNotFoundException
- if there is no java compiler Translator
registered in the build system (ex: can't find Ojc).
java.lang.IllegalStateException
- if the build system is not available (ex:
there is already a compilation session going on).
java.lang.Exception
public int compileInThread(java.lang.Thread thread, Project prj, java.util.ArrayList files, boolean rebuild)
thread
- -- a compiler thread objectprj
- -- the project context to use to buildfiles
- -- one of more files to build (must be subclass of Storage)rebuild
- -- if true, rebuild file(s) else make file(s)
public boolean addCopyListener(CopyListener cl)
CopyListener
for more information.
addCopyListener
in class Compiler
cl
- -- copy listener to add
public boolean removeCopyListener(CopyListener cl)
CopyListener
for more information.
removeCopyListener
in class Compiler
cl
- -- copy listener to remove
public boolean addBuildSystemListener(BuildSystemListener bsl)
BuildSystemListener
for more information.
addBuildSystemListener
in class Compiler
bsl
- build system listener to add
public boolean removeBuildSystemListener(BuildSystemListener bsl)
BuildSystemListener
for more information.
removeBuildSystemListener
in class Compiler
bsl
- build system listener to remove
public boolean lock(Context context, boolean wait)
Compiler
lock
in class Compiler
context
- -- workspace, project or file to lock/unlockwait
- -- if true, wait for compilation to terminate
public boolean unlock(Context context)
unlock
in class Compiler
public LogPage getOutputLog()
Compiler
getOutputLog
in class Compiler
public void logOutMsg(java.lang.String msg)
Compiler
logOutMsg
in class Compiler
msg
- -- msg to print on the logpublic static java.util.logging.Logger getLogger()
public LogPage getErrorLog()
getErrorLog
in class Compiler
public void registerTranslator(Translator translator)
public void unregisterTranslator(Translator translator)
public void registerNavigable(Navigable navigable)
Navigable
as a child of the Compiler
Navigable
in the Project Settings Dialog.
navigable
- The child Navigable
to add.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |