org.scijava.command

Class ModuleCommand

java.lang.Object

org.scijava.module.AbstractModule

org.scijava.command.ModuleCommand

All Implemented Interfaces:

Runnable, Cancelable, Command, Contextual, Module, SciJavaPlugin

public abstract class ModuleCommand
extends AbstractModule
implements Cancelable, Command, Contextual

A command which implements Module directly (rather than using the CommandModule adapter class). This is useful for commands which want to inspect and manipulate their own inputs and outputs programmatically.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
ModuleCommand()

Method Summary

Modifier and Type	Method and Description
void	cancel(String reason) Cancels the operation execution, with the given reason for doing so.
String	getCancelReason() Gets a message describing why the operation was canceled.
Context	getContext() Gets the application context to which the object belongs, or null if Contextual.setContext(Context) has not yet been called on this object.
CommandInfo	getInfo() Gets metadata about this module.
boolean	isCanceled() Gets whether the operation has been canceled.
void	setContext(Context context) Sets the application context to which the object belongs.

Methods inherited from class org.scijava.module.AbstractModule

cancel, getDelegateObject, getInput, getInputs, getOutput, getOutputs, initialize, isInputResolved, isOutputResolved, preview, resolveInput, resolveOutput, setInput, setInputs, setOutput, setOutputs, unresolveInput, unresolveOutput

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface org.scijava.Contextual

context

Methods inherited from interface org.scijava.module.Module

isResolved, setResolved

Constructor Detail

ModuleCommand

public ModuleCommand()

Method Detail

getInfo

public CommandInfo getInfo()

Description copied from interface: Module

Gets metadata about this module.

Specified by:

getInfo in interface Module

getContext

public Context getContext()

Description copied from interface: Contextual

Gets the application context to which the object belongs, or null if Contextual.setContext(Context) has not yet been called on this object.

Specified by:

getContext in interface Contextual

See Also:

Contextual.context()

setContext

public void setContext(Context context)

Description copied from interface: Contextual

Sets the application context to which the object belongs.

Typically this method simply delegates to Context.inject(Object), and should be called only once to populate the context. Most contextual objects do not support later alteration of the context, and will throw IllegalStateException if this method is invoked again.

Specified by:

setContext in interface Contextual

See Also:

Context.inject(Object)

isCanceled

public boolean isCanceled()

Description copied from interface: Cancelable

Gets whether the operation has been canceled.

Specified by:

isCanceled in interface Cancelable

cancel

public void cancel(String reason)

Description copied from interface: Cancelable

Cancels the operation execution, with the given reason for doing so.

This method merely sets the operation status to canceled; it cannot necessarily stop the operation itself. That is, it is the responsibility of each individual operation to check Cancelable.isCanceled() in a timely manner during execution, and stop doing whatever it is doing if the flag has been tripped.

Specified by:

cancel in interface Cancelable

Parameters:

reason - A message describing why the operation is being canceled.

getCancelReason

public String getCancelReason()

Description copied from interface: Cancelable

Gets a message describing why the operation was canceled.

Specified by:

getCancelReason in interface Cancelable

Returns:

The reason for cancelation, which may be null if no reason was given, or if the operation was not in fact canceled.