oracle.ide.compiler

Class CompileArguments

java.lang.Object

oracle.ide.compiler.CompileArguments

public class CompileArguments
extends java.lang.Object

This class defines the arguments for a compilation using the Compiler.compile(CompileArguments) entrypoint. Code that wants to use compile services calls any desired setters and the build system will call any getters it's interested in.

Since:

11.1.2.0.0

Constructor Summary

Constructors

Constructor and Description
CompileArguments(Context context) Create a new CompileArguments object.

Method Summary

Modifier and Type	Method and Description
void	addJavaCompilerOption(java.lang.String option, java.lang.String argument) Add a Java compiler option which will be appended at the end of the options for the Java compiler
void	addJavaCompilerOptions(java.lang.String options) Add the options to be appended to the options for the Java compiler.
boolean	getClearLogBeforeCompile() Deprecated. Since 12.1.2.0.0, use isClearLogBeforeCompile()
Context	getContext() Get the Context that defines the targets that will be compiled.
java.io.OutputStream	getDiagnosticsStream() Get the OutputStream for compilation diagnostics if those diagnostics need to be redirected.
java.util.Map<java.lang.String,java.lang.String>	getJavaCompilerOptions() Get the options to be appended to the options for the Java compiler.
java.io.OutputStream	getOutputStream() Get the OutputStream for compilation output (any non-diagnostic output) if that output needs to be redirected.
PostBuilder	getPostBuilder() The PostBuilder which will be used after the compilation has finished.
boolean	isClearLogBeforeCompile() Get the clear log before compile setting.
boolean	isCompileDependencies() Determine if the build should compile the project's dependencies first before a project compile.
boolean	isCompileDependentProjects() Deprecated. Use isCompileDependencies() instead
boolean	isForceRebuildOnProjectChanges() Determine if the build should turn a 'build' into a 'rebuild' IFF the project settings were changed since the last build of the project.
boolean	isQuiet() Determine if the build shows it progress, meaning the names of the files compiled and written.
boolean	isRebuildAllSources() If true, only the sources specified by the context are compiled; if false, the specified sources and all sources that depend on those sources compiled ( a 'make' ).
boolean	isSaveBeforeCompiling() If true, AND the IDE setting to save before compile is true (see Preferences | Compiler | Save All before Compiling), a save-all is issued before the compilation.
boolean	isThrowOnConcurrentCleanOrCompile() Determine if the build system should throw a IllegalStateException when it is already busy with another clean or compile, instead of reporting the failure on the output and diagnostics streams or on stdout and stderr if the streams are not set.
boolean	isWaitForTermination() If true, the compile call will not return till the compile is finished; if false, the compile call will return immediately.
boolean	isWaitOnConcurrentCleanOrCompile() Determine if the build system should wait for a concurrent clean or compile to finish before executing this build.
void	setClearLogBeforeCompile(boolean clearLogBeforeCompile) Override the clear log before compile setting in IDE preferences just for this compile
void	setCompileDepdendentProjects(boolean compileDependencies) Deprecated. Use setCompileDependencies(boolean) instead
void	setCompileDependencies(boolean compileDependencies) Set the compile dependencies flag, which indicates if dependencies should be compiled before a project is compiled.
void	setDiagnosticsStream(java.io.OutputStream diagnosticsStream) Set the output stream that should be used for diagnostics.
void	setForceRebuildOnProjectChanges(boolean forceRebuildOnProjectChanges) Update the setting to make the build turn a 'build' into a 'rebuild' IFF the project settings were changed since the last build of the project.
void	setOutputStream(java.io.OutputStream outputStream) Set the output stream that should be used for compilation output (any non-diagnostic output).
void	setPostBuilder(PostBuilder postBuilder) Set the PostBuilder that will be used after the compilation.
void	setQuiet(boolean quiet) Update the setting that determines if the build shows its progress, meaning the names of the files compiled and written.
void	setRebuildAllSources(boolean rebuildAllSources) Set the rebuild all sources flag.
void	setSaveBeforeCompiling(boolean saveBeforeCompiling) Set the save before compiling flag.
void	setThrowOnConcurrentCleanOrCompile(boolean throwOnConcurrentCleanOrCompile) Update the setting that determines if the build system should throw a IllegalStateException when it is already busy with another clean or compile, instead of reporting the failure on the output and diagnostics streams or on stdout and stderr if the streams are not set.
void	setWaitForTermination(boolean waitForTermination) Set the wait for termination flag.
void	setWaitOnConcurrentCleanOrCompile(boolean waitOnConcurrentCleanOrCompile) Update the setting that determines if the build system should wait for a concurrent clean or compile to finish before executing this build.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompileArguments

public CompileArguments(Context context)

Create a new CompileArguments object.

Parameters:

context - The context that defines what will be compiled, which cannot be null. To compile one target, such as a Workspace or a Project, use Context.setNode(oracle.ide.model.Node). To compile multiple targets, use Context.setSelection(oracle.ide.model.Element[])

Throws:

java.lang.IllegalArgumentException - if context is null

Method Detail

getContext

public Context getContext()

Get the Context that defines the targets that will be compiled.

Returns:

A Context that defines what needs to be compiled, which will not be null

isRebuildAllSources

public boolean isRebuildAllSources()

If true, only the sources specified by the context are compiled; if false, the specified sources and all sources that depend on those sources compiled ( a 'make' ). The default of this flag is false.

Returns:

True if a rebuild is desired, false if a make is desired

setRebuildAllSources

public void setRebuildAllSources(boolean rebuildAllSources)

Set the rebuild all sources flag. By default this flag is false.

Parameters:

rebuildAllSources - The flag that indicates if all sources should be rebuild or not. For a rebuild, use true, for a make, use false

isSaveBeforeCompiling

public boolean isSaveBeforeCompiling()

If true, AND the IDE setting to save before compile is true (see Preferences | Compiler | Save All before Compiling), a save-all is issued before the compilation. By default this flag is false

Returns:

True if a save before compilation is desired

setSaveBeforeCompiling

public void setSaveBeforeCompiling(boolean saveBeforeCompiling)

Set the save before compiling flag. By default this flag is false.

Parameters:

saveBeforeCompiling - The save before compiling flag

isWaitForTermination

public boolean isWaitForTermination()

If true, the compile call will not return till the compile is finished; if false, the compile call will return immediately. By default this flag is true.

Returns:

True if the compile call should wait for termination of the compile, false otherwise

setWaitForTermination

public void setWaitForTermination(boolean waitForTermination)

Set the wait for termination flag. By default this flag is true

Parameters:

waitForTermination - The new flag

isCompileDependentProjects

@Deprecated
public boolean isCompileDependentProjects()

Deprecated. Use isCompileDependencies() instead

Determine if the build should compile the project's dependencies first before a project compile. This flag is true by default.

Returns:

If true, dependencies of a project are compiled before the project itself, if false, only the project itself is compiled

isCompileDependencies

public boolean isCompileDependencies()

Determine if the build should compile the project's dependencies first before a project compile. This flag is true by default.

Returns:

If true, dependencies of a project are compiled before the project itself, if false, only the project itself is compiled

setCompileDepdendentProjects

@Deprecated
public void setCompileDepdendentProjects(boolean compileDependencies)

Deprecated. Use setCompileDependencies(boolean) instead

Set the compile dependencies flag, which indicates if dependencies should be compiled before a project is compiled. This flag is true by default.

Parameters:

compileDependencies - The new flag

setCompileDependencies

public void setCompileDependencies(boolean compileDependencies)

Set the compile dependencies flag, which indicates if dependencies should be compiled before a project is compiled. This flag is true by default.

Parameters:

compileDependencies - The new flag

getOutputStream

public java.io.OutputStream getOutputStream()

Get the OutputStream for compilation output (any non-diagnostic output) if that output needs to be redirected. By default this method returns null which forces output to go to STDOUT (System.out).

Returns:

An OutputStream, or null if output doesn't need to be redirected

setOutputStream

public void setOutputStream(java.io.OutputStream outputStream)

Set the output stream that should be used for compilation output (any non-diagnostic output). By default compilation output is send to SDTOUT.

Parameters:

outputStream - The output stream to be used for compilation output

getDiagnosticsStream

public java.io.OutputStream getDiagnosticsStream()

Get the OutputStream for compilation diagnostics if those diagnostics need to be redirected. By default this method return null, which forces diagnostics go to SDTERR (System.err).

Returns:

An OutputStream, or null if diagnostics don't need to be redirected

setDiagnosticsStream

public void setDiagnosticsStream(java.io.OutputStream diagnosticsStream)

Set the output stream that should be used for diagnostics. By default, diagnostics are send to STDERR.

Parameters:

diagnosticsStream - The output stream to be used for diagnostics

getPostBuilder

public PostBuilder getPostBuilder()

The PostBuilder which will be used after the compilation has finished. By default there is no PostBuilder defined.

Returns:

A PostBuilder or null if there is none.

setPostBuilder

public void setPostBuilder(PostBuilder postBuilder)

Set the PostBuilder that will be used after the compilation. By default no PostBuilder is used.

Parameters:

postBuilder - The PostBuilder to be used after the compilation

getClearLogBeforeCompile

@Deprecated
public boolean getClearLogBeforeCompile()

Deprecated. Since 12.1.2.0.0, use isClearLogBeforeCompile()

Get the clear log before compile setting. Unless specifically overridden for this compile only, this will return the clear log before compile setting of the IDE preferences

Returns:

The clear log before compile setting for this compile

isClearLogBeforeCompile

public boolean isClearLogBeforeCompile()

Get the clear log before compile setting. Unless specifically overridden for this compile only, this will return the clear log before compile setting of the IDE preferences

Returns:

The clear log before compile setting for this compile

setClearLogBeforeCompile

public void setClearLogBeforeCompile(boolean clearLogBeforeCompile)

Override the clear log before compile setting in IDE preferences just for this compile

Parameters:

clearLogBeforeCompile - The clear log before compile setting for this compile only

addJavaCompilerOption

public void addJavaCompilerOption(java.lang.String option,
                                  java.lang.String argument)

Add a Java compiler option which will be appended at the end of the options for the Java compiler

Parameters:

option - An option which cannot be null or empty

argument - An optional argument for the option which can be null

Throws:

java.lang.IllegalArgumentException - for an invalid option

getJavaCompilerOptions

public java.util.Map<java.lang.String,java.lang.String> getJavaCompilerOptions()

Get the options to be appended to the options for the Java compiler.

Returns:

A map with options which will not be null but might be empty

addJavaCompilerOptions

public void addJavaCompilerOptions(java.lang.String options)

Add the options to be appended to the options for the Java compiler. Options and their arguments should be separated by commas. Any commas in options or arguments should be escaped with a \ character, e.g. "-g:lines\,vars,-source,1.6,-target,1.7" is a valid value for the options String and means the option -g:lines,vars followed by the option -source with argument 1.6 followed by the option -target with argument 1.7.

Parameters:

options - A specially formatted string containing options

setForceRebuildOnProjectChanges

public void setForceRebuildOnProjectChanges(boolean forceRebuildOnProjectChanges)

Update the setting to make the build turn a 'build' into a 'rebuild' IFF the project settings were changed since the last build of the project. True by default.

Parameters:

forceRebuildOnProjectChanges - If true, build will turn a 'build' into a 'rebuild'

isForceRebuildOnProjectChanges

public boolean isForceRebuildOnProjectChanges()

Determine if the build should turn a 'build' into a 'rebuild' IFF the project settings were changed since the last build of the project. True by default.

Returns:

True if the build should turn a 'build' into a 'rebuild'

setQuiet

public void setQuiet(boolean quiet)

Update the setting that determines if the build shows its progress, meaning the names of the files compiled and written. By default this value is determined by the value of the global IDE option to show compile progress or not, which is true by default.

Parameters:

quiet - If true, the build does not show its progress

isQuiet

public boolean isQuiet()

Determine if the build shows it progress, meaning the names of the files compiled and written. By default this value is determined by the value of the global IDE option to show compile progress or not, which is true by default.

Returns:

True if the build does not show its progress

setThrowOnConcurrentCleanOrCompile

public void setThrowOnConcurrentCleanOrCompile(boolean throwOnConcurrentCleanOrCompile)

Update the setting that determines if the build system should throw a IllegalStateException when it is already busy with another clean or compile, instead of reporting the failure on the output and diagnostics streams or on stdout and stderr if the streams are not set. False by default. If this setting is true, the isWaitOnConcurrentCleanOrCompile() setting is ignored.

Parameters:

throwOnConcurrentCleanOrCompile - The new setting

isThrowOnConcurrentCleanOrCompile

public boolean isThrowOnConcurrentCleanOrCompile()

Determine if the build system should throw a IllegalStateException when it is already busy with another clean or compile, instead of reporting the failure on the output and diagnostics streams or on stdout and stderr if the streams are not set. False by default. If this setting is true, the isWaitOnConcurrentCleanOrCompile() setting is ignored.

Returns:

True if the build system will throw an exception

setWaitOnConcurrentCleanOrCompile

public void setWaitOnConcurrentCleanOrCompile(boolean waitOnConcurrentCleanOrCompile)

Update the setting that determines if the build system should wait for a concurrent clean or compile to finish before executing this build. False by default. This setting is ignored if the isThrowOnConcurrentCleanOrCompile() setting is true.

Parameters:

waitOnConcurrentCleanOrCompile - The new setting

isWaitOnConcurrentCleanOrCompile

public boolean isWaitOnConcurrentCleanOrCompile()

Determine if the build system should wait for a concurrent clean or compile to finish before executing this build. False by default. This setting is ignored if the isThrowOnConcurrentCleanOrCompile() setting is true.

Returns:

True if the build should wait