org.netbeans.spi.editor.document

Interface OnSaveTask

All Superinterfaces:

Cancellable

public interface OnSaveTask
extends Cancellable

Task done right before document is saved. Factories need to be registered in MimeLookup.

Since:

1.66

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OnSaveTask.Context Context given to factory for production of on-save task.
static interface	OnSaveTask.Factory Factory for creation of on-save task.
static class	OnSaveTask.PackageAccessor

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel processing of the job.
void	performTask() Perform the task on the context (given to factory that produced this task).
void	runLocked(Runnable run) Perform the given runnable under a lock specific for this task.

Method Detail

performTask

void performTask()

Perform the task on the context (given to factory that produced this task).

runLocked

void runLocked(@NonNull
               Runnable run)

Perform the given runnable under a lock specific for this task. The runnable will include a call to OnSaveTask.performTask() but it may also call other tasks if there are multiple ones.
For multiple task factories registered their OnSaveTask.runLocked(java.lang.Runnable) methods will be called subsequently (according to their registration order) in a nested way.

Parameters:

run - non-null runnable provided by the infrastructure.

cancel

boolean cancel()

Cancel processing of the job. Called not more than once for specific job.

Specified by:

cancel in interface Cancellable

Returns:

true if the job was successfully canceled, false if job can't be canceled for some reason.

See Also:

Cancellable