fiji.plugin.trackmate.util.cli

Class CLIConfigurator

java.lang.Object

fiji.plugin.trackmate.util.cli.CLIConfigurator

Direct Known Subclasses:

CommandCLIConfigurator, CondaCLIConfigurator

public abstract class CLIConfigurator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CLIConfigurator.AbstractStringArgument<T extends CLIConfigurator.AbstractStringArgument<T>>
static class	CLIConfigurator.Argument<T extends CLIConfigurator.Argument<T,O>,O> Mother class for command arguments.
static interface	CLIConfigurator.ArgumentVisitor
static class	CLIConfigurator.BoundedValueArgument<T extends CLIConfigurator.BoundedValueArgument<T,O>,O>
protected class	CLIConfigurator.ChoiceAdder
static class	CLIConfigurator.ChoiceArgument
protected class	CLIConfigurator.DoubleAdder
static class	CLIConfigurator.DoubleArgument
static class	CLIConfigurator.Flag
protected class	CLIConfigurator.FlagAdder
protected class	CLIConfigurator.IntAdder
static class	CLIConfigurator.IntArgument
protected class	CLIConfigurator.PathAdder
static class	CLIConfigurator.PathArgument Specialization of CLIConfigurator.StringArgument to be used in a GUI.
static class	CLIConfigurator.SelectableArguments
protected class	CLIConfigurator.StringAdder
static class	CLIConfigurator.StringArgument

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CLIConfigurator.Argument<?,?>>	arguments
protected List<CLIConfigurator.SelectableArguments>	selectables
protected Map<CLIConfigurator.Argument<?,?>,Function<Object,List<String>>>	translators

Constructor Summary

Constructors

Constructor and Description
CLIConfigurator()

Method Summary

Modifier and Type	Method and Description
protected CLIConfigurator.ChoiceAdder	addChoiceArgument()
protected CLIConfigurator.DoubleAdder	addDoubleArgument()
protected <T extends CLIConfigurator.Argument<?,?>> T	addExtraArgument(T extraArg) Adds an extra argument, defined by other means than the adder methods.
protected CLIConfigurator.FlagAdder	addFlag()
protected CLIConfigurator.IntAdder	addIntArgument()
protected CLIConfigurator.PathAdder	addPathArgument()
protected CLIConfigurator.SelectableArguments	addSelectableArguments() Creates a 'one or the other' relationships.
protected CLIConfigurator.StringAdder	addStringArgument()
String	check()
List<CLIConfigurator.Argument<?,?>>	getArguments() Returns the list of arguments (plus the command) in this CLI config.
abstract CLIConfigurator.Argument<?,?>	getCommandArg() Returns the command object of this tool.
List<CLIConfigurator.SelectableArguments>	getSelectables() Returns the list of CLIConfigurator.SelectableArguments in this CLI config.
List<CLIConfigurator.Argument<?,?>>	getSelectedArguments() Returns the list of arguments set in this CLI config.
protected void	setTranslator(CLIConfigurator.Argument<?,?> arg, Function<Object,List<String>> translator)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

arguments

protected final List<CLIConfigurator.Argument<?,?>> arguments

selectables

protected final List<CLIConfigurator.SelectableArguments> selectables

translators

protected final Map<CLIConfigurator.Argument<?,?>,Function<Object,List<String>>> translators

Constructor Detail

CLIConfigurator

public CLIConfigurator()

Method Detail

getArguments

public List<CLIConfigurator.Argument<?,?>> getArguments()

Returns the list of arguments (plus the command) in this CLI config. All arguments are present, regardless of whether they are in CLIConfigurator.SelectableArguments, CLIConfigurator.Argument.visible or not, CLIConfigurator.Argument.inCLI or not.

Returns:

the list of arguments.

getSelectables

public List<CLIConfigurator.SelectableArguments> getSelectables()

Returns the list of CLIConfigurator.SelectableArguments in this CLI config.

Returns:

the list of CLIConfigurator.SelectableArguments.

getSelectedArguments

public List<CLIConfigurator.Argument<?,?>> getSelectedArguments()

Returns the list of arguments set in this CLI config. The list contains only the arguments that are selected if they are in a CLIConfigurator.SelectableArguments, and those who are not in a CLIConfigurator.SelectableArguments.

Returns:

the selected arguments.

setTranslator

protected void setTranslator(CLIConfigurator.Argument<?,?> arg,
                             Function<Object,List<String>> translator)

addSelectableArguments

protected CLIConfigurator.SelectableArguments addSelectableArguments()

Creates a 'one or the other' relationships. The arguments that will be passed to the CLIConfigurator.SelectableArguments will be flagged as as not to be used concurrently in the same command. This will be used when creating UIs.

Returns:

addFlag

protected CLIConfigurator.FlagAdder addFlag()

addStringArgument

protected CLIConfigurator.StringAdder addStringArgument()

addPathArgument

protected CLIConfigurator.PathAdder addPathArgument()

addIntArgument

protected CLIConfigurator.IntAdder addIntArgument()

addDoubleArgument

protected CLIConfigurator.DoubleAdder addDoubleArgument()

addChoiceArgument

protected CLIConfigurator.ChoiceAdder addChoiceArgument()

addExtraArgument

protected <T extends CLIConfigurator.Argument<?,?>> T addExtraArgument(T extraArg)

Adds an extra argument, defined by other means than the adder methods.

Parameters:

extraArg - the argument to add to this CLI config.

Returns:

the argument

toString

public String toString()

Overrides:

toString in class Object

check

public String check()

getCommandArg

public abstract CLIConfigurator.Argument<?,?> getCommandArg()

Returns the command object of this tool.

Returns:

the command object, as an argument.