| org.netbeans.modules.uml.util.ITaskSupervisor
All known Subclasses: org.netbeans.modules.uml.util.AbstractNBTask,
| ITaskSupervisor | | public interface ITaskSupervisor (Code) | |
author:
Craig Conover, craig.conover@sun.com |
| Field Summary | |
| final public static int | DEBUG
| | final public static int | SUMMARY
| | final public static int | TERSE
| | final public static int | VERBOSE
|
| Method Summary | |
| public boolean | cancel()
Call this method when a the task is instructed to be canceled and it
will set the cancelled flag to false. | | public void | fail()
Call this method when a failure in your task is detected and it will
set the success flag to false. | | public int | increment()
Increment the item counter by one. | | public int | increment(int step)
Increment the item counter by the amount of the step parameter.
Parameters:
step - the amount to increment the counter. | | public void | log()
| | public void | log(int level)
| | public void | log(String msg)
| | public void | log(int level, String msg)
| | public void | log(String msg, boolean newline)
| | public void | log(int level, String msg, boolean newline)
| | public boolean | proceed()
Called by task subclass to check confirm that the task hasn't been
cancelled or failed. | | public boolean | proceed(int step)
Called by task subclass to check confirm that the task hasn't been
cancelled or failed. | | public boolean | start(int itemTotal)
| | public boolean | start(int contributor, int itemTotal)
|
| DEBUG | | final public static int DEBUG(Code) | | |
| SUMMARY | | final public static int SUMMARY(Code) | | |
| TERSE | | final public static int TERSE(Code) | | |
| VERBOSE | | final public static int VERBOSE(Code) | | |
| cancel | | public boolean cancel()(Code) | | Call this method when a the task is instructed to be canceled and it
will set the cancelled flag to false. The next time proceed() is
called, it will invoke finish() return false.
|
| fail | | public void fail()(Code) | | Call this method when a failure in your task is detected and it will
set the success flag to false. The next time proceed() is called,
it will invoke finish() return false.
|
| increment | | public int increment()(Code) | | Increment the item counter by one.
the current count after incrementing by one |
| increment | | public int increment(int step)(Code) | | Increment the item counter by the amount of the step parameter.
Parameters:
step - the amount to increment the counter. the current count after incrementing by the amount of the step parameter. |
| log | | public void log()(Code) | | Outputs a blank line
|
| log | | public void log(int level)(Code) | | |
| log | | public void log(String msg)(Code) | | Outputs a message with and appends newline by default
Parameters:
msg - the message to be output |
| log | | public void log(String msg, boolean newline)(Code) | | Outputs a message
Parameters:
msg - the message to be output
Parameters:
newline - if true, appends newline |
| log | | public void log(int level, String msg, boolean newline)(Code) | | |
| proceed | | public boolean proceed()(Code) | | Called by task subclass to check confirm that the task hasn't been
cancelled or failed. If there is a cancellation or failure, finish()
is called.
true if the process hasn't failed or been canceled |
| proceed | | public boolean proceed(int step)(Code) | | Called by task subclass to check confirm that the task hasn't been
cancelled or failed. If there is a cancellation or failure, finish()
is called.
Parameters:
step - the amount to increment the counter by. true if the process hasn't failed or been canceled |
| start | | public boolean start(int itemTotal)(Code) | | |
| start | | public boolean start(int contributor, int itemTotal)(Code) | | |
|
|