Skip to content

Commit 4af4d34

Browse files
committed
CommandService: clarify ModuleService usage
Added javadoc explaining when ModuleService#run methods should be used.
1 parent 4543593 commit 4af4d34

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/main/java/org/scijava/command/CommandService.java

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@ <C extends Command> List<CommandInfo> getCommandsOfClass(
117117
* @param process If true, executes the command with pre- and postprocessing
118118
* steps from all available {@link PreprocessorPlugin}s and
119119
* {@link PostprocessorPlugin}s in the plugin index; if false,
120-
* executes the command with no pre- or postprocessing.
120+
* executes the command with no pre- or postprocessing. For more
121+
* fine-grained control, see the {@link ModuleService#run} methods.
121122
* @param inputs List of input parameter names and values. The expected order
122123
* is in pairs: an input name followed by its value, for each desired
123124
* input to populate. Leaving some inputs unpopulated is allowed.
@@ -142,7 +143,8 @@ <C extends Command> List<CommandInfo> getCommandsOfClass(
142143
* @param process If true, executes the command with pre- and postprocessing
143144
* steps from all available {@link PreprocessorPlugin}s and
144145
* {@link PostprocessorPlugin}s in the plugin index; if false,
145-
* executes the command with no pre- or postprocessing.
146+
* executes the command with no pre- or postprocessing. For more
147+
* fine-grained control, see the {@link ModuleService#run} methods.
146148
* @param inputMap Table of input parameter values, with keys matching the
147149
* plugin's input parameter names. Passing a value of a type
148150
* incompatible with the associated input parameter will issue an
@@ -166,7 +168,8 @@ Future<CommandModule> run(String className, boolean process,
166168
* @param process If true, executes the command with pre- and postprocessing
167169
* steps from all available {@link PreprocessorPlugin}s and
168170
* {@link PostprocessorPlugin}s in the plugin index; if false,
169-
* executes the command with no pre- or postprocessing.
171+
* executes the command with no pre- or postprocessing. For more
172+
* fine-grained control, see the {@link ModuleService#run} methods.
170173
* @param inputs List of input parameter names and values. The expected order
171174
* is in pairs: an input name followed by its value, for each desired
172175
* input to populate. Leaving some inputs unpopulated is allowed.
@@ -192,7 +195,8 @@ <C extends Command> Future<CommandModule> run(Class<C> commandClass,
192195
* @param process If true, executes the command with pre- and postprocessing
193196
* steps from all available {@link PreprocessorPlugin}s and
194197
* {@link PostprocessorPlugin}s in the plugin index; if false,
195-
* executes the command with no pre- or postprocessing.
198+
* executes the command with no pre- or postprocessing. For more
199+
* fine-grained control, see the {@link ModuleService#run} methods.
196200
* @param inputMap Table of input parameter values, with keys matching the
197201
* plugin's input parameter names. Passing a value of a type
198202
* incompatible with the associated input parameter will issue an
@@ -210,7 +214,8 @@ <C extends Command> Future<CommandModule> run(Class<C> commandClass,
210214
* @param process If true, executes the command with pre- and postprocessing
211215
* steps from all available {@link PreprocessorPlugin}s and
212216
* {@link PostprocessorPlugin}s in the plugin index; if false,
213-
* executes the command with no pre- or postprocessing.
217+
* executes the command with no pre- or postprocessing. For more
218+
* fine-grained control, see the {@link ModuleService#run} methods.
214219
* @param inputs List of input parameter names and values. The expected order
215220
* is in pairs: an input name followed by its value, for each desired
216221
* input to populate. Leaving some inputs unpopulated is allowed.
@@ -230,7 +235,8 @@ <C extends Command> Future<CommandModule> run(Class<C> commandClass,
230235
* @param process If true, executes the command with pre- and postprocessing
231236
* steps from all available {@link PreprocessorPlugin}s and
232237
* {@link PostprocessorPlugin}s in the plugin index; if false,
233-
* executes the command with no pre- or postprocessing.
238+
* executes the command with no pre- or postprocessing. For more
239+
* fine-grained control, see the {@link ModuleService#run} methods.
234240
* @param inputMap Table of input parameter values, with keys matching the
235241
* plugin's input parameter names. Passing a value of a type
236242
* incompatible with the associated input parameter will issue an

0 commit comments

Comments
 (0)