io.devcon5.cli

Class CLI

java.lang.Object

io.devcon5.cli.CLI

public class CLI
extends Object

CLI helper to parse arguments and parse them into a business class with field annotated to map the arguments. Use CliOption which fields should be populated from command line argument or CliOptionGroup to declare objects that are populated by a set of arguments. To perform additional initialization steps annotate a parameter-less method with PostInject.

Method Summary

Modifier and Type	Method and Description
<T> boolean	into(T target) The target object to parse the arguments into.
static CLI	parse(String... args) Creates a new CLI instance for the given arguments.
void	printUsage(org.apache.commons.cli.Options opts) Prints out the options for the cli

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static CLI parse(String... args)

Creates a new CLI instance for the given arguments.

Parameters:

args - the arguments to parse

Returns:

into

public <T> boolean into(T target)

The target object to parse the arguments into. One CLI can be injected into multiple targets. The target may have fields annotated with CliOption or CliOptionGroup which are required to populate those fields with values from the argline

Type Parameters:

T - the type of the target

Parameters:

target - the target to parse values into

Returns:

true, if the arguments could be successfully parsed and assigned

printUsage

public void printUsage(org.apache.commons.cli.Options opts)

Prints out the options for the cli