org.scijava.command.CommandService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation
Show all versions of scijava-common Show documentation
SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2014 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.command;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Future;
import org.scijava.event.EventService;
import org.scijava.module.Module;
import org.scijava.module.ModuleService;
import org.scijava.module.process.PostprocessorPlugin;
import org.scijava.module.process.PreprocessorPlugin;
import org.scijava.plugin.PTService;
import org.scijava.plugin.PluginInfo;
import org.scijava.plugin.PluginService;
import org.scijava.plugin.SciJavaPlugin;
import org.scijava.service.SciJavaService;
/**
* Interface for service that keeps track of available commands.
*
* A command is a particular type of plugin that is also a
* {@link Module}; i.e., it is {@link Runnable}, with typed inputs and outputs.
*
* The command service keeps a master index of all commands known to the system.
* It asks the {@link PluginService} for available commands, then takes care of
* registering them with the {@link ModuleService}.
*
*
* @author Curtis Rueden
* @see SciJavaPlugin
* @see ModuleService
* @see PluginService
*/
public interface CommandService extends PTService, SciJavaService {
EventService getEventService();
ModuleService getModuleService();
/** Gets the list of all available {@link Command}s). */
List getCommands();
/** Gets the list of {@link Command}s corresponding to the given plugins. */
List getCommands(
final List> plugins);
/** Gets the first available command of the given class, or null if none. */
CommandInfo getCommand(Class commandClass);
/**
* Gets the first available command of the given class name, or null if none.
*/
CommandInfo getCommand(String className);
/** Gets the list of {@link Command}s of the given type. */
List getCommandsOfType(Class type);
/**
* Gets the list of commands of the given class.
*
* Most classes will have only a single match, but some special classes (such
* as ImageJ's {@code LegacyCommand}) may match many entries.
*
*
* NB: Classes are matched by strict equality, not assignability; subtypes of
* the specified class will not match. For this behavior, use
* {@link #getCommandsOfType(Class)} on a common parent interface.
*
*/
List getCommandsOfClass(
Class commandClass);
/**
* Gets the list of commands with the given class name.
*
* Most classes will have only a single match, but some special classes (such
* as ImageJ's {@code LegacyCommand}) may match many entries.
*
*
* NB: Classes are matched by strict equality, not assignability; subtypes of
* the specified class will not match. For this behavior, use
* {@link #getCommandsOfType(Class)} on a common parent interface.
*
*/
List getCommandsOfClass(String className);
/**
* Executes the first command of the given class name.
*
* If no command with the given class name is registered with the service,
* then a default one is created and then executed. This default command is
* not registered with the service for subsequent usage.
*
*
* @param className Class name of the command to execute.
* @param process If true, executes the command with pre- and postprocessing
* steps from all available {@link PreprocessorPlugin}s and
* {@link PostprocessorPlugin}s in the plugin index; if false,
* executes the command with no pre- or postprocessing. For more
* fine-grained control, see the {@link ModuleService#run} methods.
* @param inputs List of input parameter names and values. The expected order
* is in pairs: an input name followed by its value, for each desired
* input to populate. Leaving some inputs unpopulated is allowed.
* Passing the name of an input that is not valid for the plugin, or
* passing a value of a type incompatible with the associated input
* parameter, will issue an error and ignore that name/value pair.
* @return {@link Future} of the module instance being executed. Calling
* {@link Future#get()} will block until execution is complete.
*/
Future
run(String className, boolean process, Object... inputs);
/**
* Executes the first command of the given class name.
*
* If no command with the given class name is registered with the service,
* then a default one is created and then executed. This default command is
* not registered with the service for subsequent usage.
*
*
* @param className Class name of the command to execute.
* @param process If true, executes the command with pre- and postprocessing
* steps from all available {@link PreprocessorPlugin}s and
* {@link PostprocessorPlugin}s in the plugin index; if false,
* executes the command with no pre- or postprocessing. For more
* fine-grained control, see the {@link ModuleService#run} methods.
* @param inputMap Table of input parameter values, with keys matching the
* plugin's input parameter names. Passing a value of a type
* incompatible with the associated input parameter will issue an
* error and ignore that value.
* @return {@link Future} of the module instance being executed. Calling
* {@link Future#get()} will block until execution is complete.
*/
Future run(String className, boolean process,
Map inputMap);
/**
* Executes the first command of the given class.
*
* If no command of the given class is registered with the service, then a
* default one is created and then executed. This default command is
* not registered with the service for subsequent usage.
*
*
* @param Class of the command to execute.
* @param commandClass Class object of the command to execute.
* @param process If true, executes the command with pre- and postprocessing
* steps from all available {@link PreprocessorPlugin}s and
* {@link PostprocessorPlugin}s in the plugin index; if false,
* executes the command with no pre- or postprocessing. For more
* fine-grained control, see the {@link ModuleService#run} methods.
* @param inputs List of input parameter names and values. The expected order
* is in pairs: an input name followed by its value, for each desired
* input to populate. Leaving some inputs unpopulated is allowed.
* Passing the name of an input that is not valid for the plugin, or
* passing a value of a type incompatible with the associated input
* parameter, will issue an error and ignore that name/value pair.
* @return {@link Future} of the module instance being executed. Calling
* {@link Future#get()} will block until execution is complete.
*/
Future run(Class commandClass,
boolean process, Object... inputs);
/**
* Executes the first command of the given class.
*
* If no command of the given class is registered with the service, then a
* default one is created and then executed. This default command is
* not registered with the service for subsequent usage.
*
*
* @param Class of the command to execute.
* @param commandClass Class object of the command to execute.
* @param process If true, executes the command with pre- and postprocessing
* steps from all available {@link PreprocessorPlugin}s and
* {@link PostprocessorPlugin}s in the plugin index; if false,
* executes the command with no pre- or postprocessing. For more
* fine-grained control, see the {@link ModuleService#run} methods.
* @param inputMap Table of input parameter values, with keys matching the
* plugin's input parameter names. Passing a value of a type
* incompatible with the associated input parameter will issue an
* error and ignore that value.
* @return {@link Future} of the module instance being executed. Calling
* {@link Future#get()} will block until execution is complete.
*/
Future run(Class commandClass,
boolean process, Map inputMap);
/**
* Executes the given command.
*
* @param info The command to instantiate and run.
* @param process If true, executes the command with pre- and postprocessing
* steps from all available {@link PreprocessorPlugin}s and
* {@link PostprocessorPlugin}s in the plugin index; if false,
* executes the command with no pre- or postprocessing. For more
* fine-grained control, see the {@link ModuleService#run} methods.
* @param inputs List of input parameter names and values. The expected order
* is in pairs: an input name followed by its value, for each desired
* input to populate. Leaving some inputs unpopulated is allowed.
* Passing the name of an input that is not valid for the plugin, or
* passing a value of a type incompatible with the associated input
* parameter, will issue an error and ignore that name/value pair.
* @return {@link Future} of the module instance being executed. Calling
* {@link Future#get()} will block until execution is complete.
*/
Future
run(CommandInfo info, boolean process, Object... inputs);
/**
* Executes the given command.
*
* @param info The command to instantiate and run.
* @param process If true, executes the command with pre- and postprocessing
* steps from all available {@link PreprocessorPlugin}s and
* {@link PostprocessorPlugin}s in the plugin index; if false,
* executes the command with no pre- or postprocessing. For more
* fine-grained control, see the {@link ModuleService#run} methods.
* @param inputMap Table of input parameter values, with keys matching the
* plugin's input parameter names. Passing a value of a type
* incompatible with the associated input parameter will issue an
* error and ignore that value.
* @return {@link Future} of the module instance being executed. Calling
* {@link Future#get()} will block until execution is complete.
*/
Future run(CommandInfo info, boolean process,
Map inputMap);
}