net.maizegenetics.util

Class ArgsEngine

net.maizegenetics.util.ArgsEngine

public class ArgsEngine

A reusable solution for Command Line Arguments Parsing in Java.

The following shows how to use this API.

  // Initiate the arguments engine.
  ArgsEngine engine = new ArgsEngine();
 
  // Configure the switches/options. Use true for valued options
  engine.add("-q", "--quiet");
  engine.add("-o", "--redirect-output", true);
  engine.add("-h", "--help");
 
  // Perform the parsing.
  engine.parse(args);
 
  // Start fetching states of switches
  boolean quiet = engine.getBoolean("-q");
 
  if(engine.getBoolean("-o"))
  {
      // For valued options, use getString.
      String redir = engine.getString("-o");
  }
  

This has been modified from the original.

Method Detail

add

public void add(java.lang.String shortForm,
                java.lang.String longForm)

Configures the engine by adding options.

Parameters:

shortForm - the short form of an option. Example: "-h".

longForm - the long form of an option. Example: "--help".

add

public void add(java.lang.String shortForm,
                java.lang.String longForm,
                boolean valued)

Configures the engine by adding options.

Parameters:

shortForm - the short form of an option. Example: "-h".

longForm - the long form of an option. Example: "--help".

valued - indicates if the option expects a value. The next argument will be considered as the value for this option.

parse

public void parse(java.lang.String[] args)

Parses the input command line arguments. The result of parsing will be stored in the current instance of ArgsEngine.

Operations net.maizegenetics.util.ArgsEngine$getBoolean(java.lang.String), #getNonOptions() and net.maizegenetics.util.ArgsEngine$getString(java.lang.String) can be then used to extract the values.

Parameters:

args - the command line arguments.

See Also:

net.maizegenetics.util.ArgsEngine$getBoolean(java.lang.String), net.maizegenetics.util.ArgsEngine$getString(java.lang.String)

getString

public java.lang.String getString(java.lang.String key)

Gets the value for a valued option.

Parameters:

key - the valued option key. Either short form or long form can be input.

Returns:

org.jetbrains.dokka.NodeRenderContent@1506a9d: the value for the option if it's valued, null otherwise.

getBoolean

public boolean getBoolean(java.lang.String key)

Gets the option.

Parameters:

key - the option's short form or long form name.

Returns:

org.jetbrains.dokka.NodeRenderContent@116b4017: true if the option is found in the args parsed, false otherwise.