X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.export.core%2Fsrc%2Forg%2Fsimantics%2Fexport%2Fcore%2Fmanager%2FExportAction.java;h=c36d22cdc9f6d4d4c30565453a0f16e791a97505;hp=94b62fbedaa63550196ab418e9eb9b4cd668633c;hb=48ea5bf055156f92d497a9a45bc05ac9d85b6f43;hpb=969bd23cab98a79ca9101af33334000879fb60c5 diff --git a/bundles/org.simantics.export.core/src/org/simantics/export/core/manager/ExportAction.java b/bundles/org.simantics.export.core/src/org/simantics/export/core/manager/ExportAction.java index 94b62fbed..c36d22cdc 100644 --- a/bundles/org.simantics.export.core/src/org/simantics/export/core/manager/ExportAction.java +++ b/bundles/org.simantics.export.core/src/org/simantics/export/core/manager/ExportAction.java @@ -1,63 +1,63 @@ -package org.simantics.export.core.manager; - -import java.util.List; - -import org.eclipse.core.runtime.IProgressMonitor; -import org.simantics.databoard.binding.mutable.Variant; -import org.simantics.export.core.ExportContext; -import org.simantics.export.core.error.ExportException; - -/** - * A single article of export action in an export plan. - * - * @author toni.kalajainen@semantum.fi - */ -public abstract class ExportAction { - - /** - * Execute export action. - * - * @param ctx - * @param progress - * @param options - * @throws ExportException - */ - public abstract void execute(ExportContext ctx, IProgressMonitor progress, Variant options) - throws ExportException; - - /** - * Get the label for this action to be used in user interface. - * - * @param ctx - * @return the label for this action. - */ - public abstract String label(ExportContext ctx); - - /** - * Get the amount of work in this action (used in progress bar). - * - * @param ctx - * @return the amount of work - */ - public abstract int work(ExportContext ctx); - - /** - * Validate action is executable - * - * @param ctx - * @param options - * @return null or a label describing the expected problem - */ - public abstract List validate(ExportContext ctx, Variant options); - - /** - * Cancel and cleanup the output of this action. Deletes temporary files. - * - * @param ctx - * @param progress - * @param options - * @throws ExportException - */ - public abstract void cleanup(ExportContext ctx, IProgressMonitor progress, Variant options) throws ExportException; - -} +package org.simantics.export.core.manager; + +import java.util.List; + +import org.eclipse.core.runtime.IProgressMonitor; +import org.simantics.databoard.binding.mutable.Variant; +import org.simantics.export.core.ExportContext; +import org.simantics.export.core.error.ExportException; + +/** + * A single article of export action in an export plan. + * + * @author toni.kalajainen@semantum.fi + */ +public abstract class ExportAction { + + /** + * Execute export action. + * + * @param ctx + * @param progress + * @param options + * @throws ExportException + */ + public abstract void execute(ExportContext ctx, IProgressMonitor progress, Variant options) + throws ExportException; + + /** + * Get the label for this action to be used in user interface. + * + * @param ctx + * @return the label for this action. + */ + public abstract String label(ExportContext ctx); + + /** + * Get the amount of work in this action (used in progress bar). + * + * @param ctx + * @return the amount of work + */ + public abstract int work(ExportContext ctx); + + /** + * Validate action is executable + * + * @param ctx + * @param options + * @return null or a label describing the expected problem + */ + public abstract List validate(ExportContext ctx, Variant options); + + /** + * Cancel and cleanup the output of this action. Deletes temporary files. + * + * @param ctx + * @param progress + * @param options + * @throws ExportException + */ + public abstract void cleanup(ExportContext ctx, IProgressMonitor progress, Variant options) throws ExportException; + +}