com.asakusafw.utils.jcommander

Class JCommanderWrapper<T>

java.lang.Object

com.asakusafw.utils.jcommander.JCommanderWrapper<T>

Type Parameters:

T - the command interface

All Implemented Interfaces:

CommandBuilder<T>

public class JCommanderWrapper<T>
extends Object
implements CommandBuilder<T>

A decorator of JCommander.

• accepts nested groups
• injects JCommander object into @Inject field of each command
• consumes @Parameter(help=true) fields

Since:

0.10.0

Version:

0.10.1

Constructor Summary

Constructors

Constructor and Description
JCommanderWrapper(String programName, Object command) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
JCommanderWrapper<T>	addCommand(String name, T command) Adds a leaf command with explicit name.
JCommanderWrapper<T>	addCommand(T command) Adds a leaf command.
JCommanderWrapper<T>	addGroup(String name, T command, Consumer<? super CommandBuilder<T>> configurator) Adds a group with explicit name.
JCommanderWrapper<T>	addGroup(T command, Consumer<? super CommandBuilder<T>> configurator) Adds a group.
JCommanderWrapper<T>	configure(Consumer<? super CommandBuilder<T>> configurator) Configures this object.
static void	handle(com.beust.jcommander.ParameterException exception, Consumer<? super String> sink) Handles ParameterException of JCommander.
Optional<T>	parse(String... args) Parses the program arguments and returns the corresponded command object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCommanderWrapper

public JCommanderWrapper(String programName,
                         Object command)

Creates a new instance.

Parameters:

programName - the program name $0

command - the root command

Method Detail

configure

public JCommanderWrapper<T> configure(Consumer<? super CommandBuilder<T>> configurator)

Configures this object.

Specified by:

configure in interface CommandBuilder<T>

Parameters:

configurator - the configurator

Returns:

this

addCommand

public JCommanderWrapper<T> addCommand(T command)

Description copied from interface: CommandBuilder

Adds a leaf command.

Specified by:

addCommand in interface CommandBuilder<T>

Parameters:

command - the command object

Returns:

this

addCommand

public JCommanderWrapper<T> addCommand(String name,
                                       T command)

Description copied from interface: CommandBuilder

Adds a leaf command with explicit name.

Specified by:

addCommand in interface CommandBuilder<T>

Parameters:

name - the command name

command - the command object

Returns:

this

addGroup

public JCommanderWrapper<T> addGroup(T command,
                                     Consumer<? super CommandBuilder<T>> configurator)

Description copied from interface: CommandBuilder

Adds a group.

Specified by:

addGroup in interface CommandBuilder<T>

Parameters:

command - the group command

configurator - the group configurator

Returns:

this

addGroup

public JCommanderWrapper<T> addGroup(String name,
                                     T command,
                                     Consumer<? super CommandBuilder<T>> configurator)

Description copied from interface: CommandBuilder

Adds a group with explicit name.

Specified by:

addGroup in interface CommandBuilder<T>

Parameters:

name - the group name

command - the group command

configurator - the group configurator

Returns:

this

parse

public Optional<T> parse(String... args)

Parses the program arguments and returns the corresponded command object.

Parameters:

args - the program arguments

Returns:

the command object, or empty if there are no commands to execute (e.g. help)

Throws:

com.beust.jcommander.ParameterException - if arguments are not valid

handle

public static void handle(com.beust.jcommander.ParameterException exception,
                          Consumer<? super String> sink)

Handles ParameterException of JCommander.

Parameters:

exception - the exception object

sink - error message sink

Since:

0.10.1