public class CleanArguments
extends java.lang.Object
Compiler.clean(CleanArguments)
entrypoint. Code
that wants to use clean services calls any desired setters
and the build system will call any getters it's interested in.Constructor and Description |
---|
CleanArguments(Context context)
Create a new CleanArguments object.
|
Modifier and Type | Method and Description |
---|---|
Context |
getContext()
Get the Context that defines the targets that will be cleaned.
|
java.io.OutputStream |
getDiagnosticsStream()
Get the OutputStream for clean diagnostics if those diagnostics need
to be redirected.
|
java.io.OutputStream |
getOutputStream()
Get the OutputStream for clean output (any non-diagnostic output) if
that output needs to be redirected.
|
boolean |
isAutoClean()
When autoClean is true, problems are resolved automatically by not performing
part or all of the clean.
|
boolean |
isRefreshApplication()
Determine if the clean should be followed by a refresh of the
application.
|
boolean |
isStopOnFailedDelete()
Determine if the clean should stop on any failed delete or if
the clean should continue and log failures.
|
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 |
isThrowOnFailedDelete()
Determine if an IOException should be thrown if delete of any file
or directory fails.
|
boolean |
isWaitForTermination()
Determine if the clean call should wait for the clean to finish,
or if it should return immediately and let the clean execute in
a worker thread.
|
boolean |
isWaitOnConcurrentCleanOrCompile()
Determine if the build system should wait for a concurrent clean or
compile to finish before executing this clean.
|
void |
setAutoClean(boolean autoClean)
When autoClean is true, problems are resolved automatically by not performing
part or all of the clean.
|
void |
setDiagnosticsStream(java.io.OutputStream diagnosticsStream)
Set the output stream that should be used for diagnostics.
|
void |
setOutputStream(java.io.OutputStream outputStream)
Set the output stream that should be used for clean output (any
non-diagnostic output).
|
void |
setRefreshApplication(boolean refreshApplication)
Update the setting that determines if the clean should be followed
by a refresh of the application.
|
void |
setStopOnFailedDelete(boolean stopOnFailedDelete)
Update the setting that determines if the clean should stop on any
failed delete or if the clean should continue and log failures.
|
void |
setThrowOnConcurrentCleanOrCompile(boolean throwOnConcurrentCleanOrCompile)
Update the setting that determines if the build 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 |
setThrowOnFailedDelete(boolean throwOnFailedDelete)
Update the setting that determines if an IOException should be thrown
if delete of any file or directory fails.
|
void |
setWaitForTermination(boolean waitForTermination)
Update the setting that determines if the clean call should wait for the
clean to finish, or if it should return immediately and let the clean
execute in a worker thread.
|
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 clean.
|
public CleanArguments(Context context)
context
- The context that defines what will be cleaned, which
cannot be null. To clean one target, such as a Workspace or a Project,
use Context.setNode(oracle.ide.model.Node)
. To clean multiple
targets, use Context.setSelection(oracle.ide.model.Element[])
java.lang.IllegalArgumentException
- if context is nullpublic Context getContext()
public java.io.OutputStream getOutputStream()
public void setOutputStream(java.io.OutputStream outputStream)
outputStream
- The output stream to be used for clean outputpublic java.io.OutputStream getDiagnosticsStream()
public void setDiagnosticsStream(java.io.OutputStream diagnosticsStream)
diagnosticsStream
- The output stream to be used for diagnosticspublic boolean isThrowOnFailedDelete()
public void setThrowOnFailedDelete(boolean throwOnFailedDelete)
throwOnFailedDelete
- If true, IOException should be thrown on failed deletespublic boolean isStopOnFailedDelete()
public void setStopOnFailedDelete(boolean stopOnFailedDelete)
stopOnFailedDelete
- If true, stop on failed deletespublic void setWaitOnConcurrentCleanOrCompile(boolean waitOnConcurrentCleanOrCompile)
isThrowOnConcurrentCleanOrCompile()
returns true.waitOnConcurrentCleanOrCompile
- The new settingpublic boolean isWaitOnConcurrentCleanOrCompile()
isThrowOnConcurrentCleanOrCompile()
is true.public void setThrowOnConcurrentCleanOrCompile(boolean throwOnConcurrentCleanOrCompile)
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.throwOnConcurrentCleanOrCompile
- The new settingpublic boolean isThrowOnConcurrentCleanOrCompile()
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.public void setRefreshApplication(boolean refreshApplication)
refreshApplication
- The new settingpublic boolean isRefreshApplication()
public void setAutoClean(boolean autoClean)
autoClean
- The new settingpublic boolean isAutoClean()
public boolean isWaitForTermination()
public void setWaitForTermination(boolean waitForTermination)
waitForTermination
- The new flag