com.github.yin.cli

Class Cli

java.lang.Object

com.github.yin.cli.Cli

public class Cli
extends Object

Stores arguments values and provides Flag accessors for the values. Arguments value must be initialized before any flag values are accessed by Flag.get() method. If arguments are provided as String[] array, the array will be parsed by LongKeyValueParser class, but any CLI parsing front-end can be used and arguments can be passed into Cli.init() method as ImmutableMultimap. Clients should be using exclusively static methods provided by this class as CLI arguments are expected to be immutable during the application runtime. An second attempt to call Cli.init() will result in an IllegalStateException. For integration testing of application modules, we provide Cli.setArguments() and Cli.clear() methods. Example:

{@code

Author:

yin

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableCollection<String>	allArguments(FlagID flagID)
static void	clear() Clears flag values after test case completes.
static <T> Flag<T>	create(Class<T> type, String name) Returns flag value accessor, which can be used to retrieve the flag value supplied by command line arguments.
TypeConversions	getTypeConversions() Type conversions used by Cli.
static void	init(com.google.common.collect.ImmutableMultimap<String,String> args) Initializes flag values from an ImmutableMultimap.
static void	init(String[] args) Initializes flag values from array of command-line arguments.
static void	printUsage(String packagePrefix) Prints user-readable usage help for all cli in a given package
String	singleArgument(FlagID flagID)
static Flag<String>	string(String name) Returns flag value accessor for String type.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(String[] args)
                 throws IllegalStateException

Initializes flag values from array of command-line arguments.

Parameters:

args - Array of command-line arguments as passed to the main() method

Throws:

IllegalStateException

init

public static void init(com.google.common.collect.ImmutableMultimap<String,String> args)
                 throws IllegalStateException

Initializes flag values from an ImmutableMultimap.

Parameters:

args - Parsed command-line arguments

Throws:

IllegalStateException

string

public static Flag<String> string(String name)

Returns flag value accessor for String type. See create().

create

public static <T> Flag<T> create(Class<T> type,
                                 String name)

Returns flag value accessor, which can be used to retrieve the flag value supplied by command line arguments. Preferably the typespecific variants (string(), ...) should be used for readability reasons.

 &at;Usage("Specifies path to input file")
 private static final Flag<String> inputPathFlag = Cli.create(String.class, "inputPath");
 

Type Parameters:

T - is the same as flag value type

Parameters:

type - of the provided flag value

name - of the flag. This is must match the name the field or name attribute in @Usage annotation

Returns:

Flag accessor for flag value identified by name

printUsage

public static void printUsage(String packagePrefix)

Prints user-readable usage help for all cli in a given package

clear

public static void clear()

Clears flag values after test case completes.

getTypeConversions

public TypeConversions getTypeConversions()

Type conversions used by Cli.

singleArgument

public String singleArgument(FlagID flagID)

allArguments

public com.google.common.collect.ImmutableCollection<String> allArguments(FlagID flagID)