org.openjax.cli

Class Options

java.lang.Object

org.openjax.cli.Options

public final class Options
extends Object

Utility class to parse options from the CLI. This class is intended to be used from main(String[]).

For example:

 public class MyApp {
   public void main(String[] args) {
     Options options = Options.parse(ClassLoader.getSystemClassLoader().getResource("cli.xml"), MyApp.class, args);
     ...
   }
 }
 

Method Summary

Modifier and Type	Method and Description
String[]	getArguments()
String	getOption(String name)
Collection<Option>	getOptions()
String[]	getOptions(String name)
static Options	parse(org.openjax.cli_1_1_7.Cli binding, String[] args) Parses args as per the CLI XML specification in the provided Cli JAXB binding.
static Options	parse(File cliFile, String[] args) Parses args as per the CLI XML specification at the provided File.
static Options	parse(URL cliURL, String[] args) Parses args as per the CLI XML specification at the provided URL.
void	printCommand(PrintStream ps, Class<?> callerClass)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static Options parse(File cliFile,
                            String[] args)
                     throws IOException

Parses args as per the CLI XML specification at the provided File.

Parameters:

cliFile - The File pointing to the CLI XML.

args - The main(String[] args).

Returns:

The parsed Options.

Throws:

IOException - If an I/O error has occurred.

parse

public static Options parse(URL cliURL,
                            String[] args)
                     throws IOException

Parses args as per the CLI XML specification at the provided URL.

Parameters:

cliURL - The URL pointing to the CLI XML.

args - The main(String[] args).

Returns:

The parsed Options.

Throws:

IOException - If an I/O error has occurred.

parse

public static Options parse(org.openjax.cli_1_1_7.Cli binding,
                            String[] args)

Parses args as per the CLI XML specification in the provided Cli JAXB binding.

Parameters:

binding - The Cli JAXB binding representing the CLI XML.

args - The main(String[] args).

Returns:

The parsed Options.

getArguments

public String[] getArguments()

Returns:

Returns an array of unnamed arguments, in original order. Returns null in case there are no unnamed arguments.

getOptions

public Collection<Option> getOptions()

getOption

public String getOption(String name)

getOptions

public String[] getOptions(String name)

printCommand

public void printCommand(PrintStream ps,
                         Class<?> callerClass)

toString

public String toString()

Overrides:

toString in class Object