io.micronaut.configuration.picocli

Class PicocliRunner

java.lang.Object

io.micronaut.configuration.picocli.PicocliRunner

public class PicocliRunner
extends Object

Utility class with convenience methods for running picocli-based commands with a micronaut application context.

Since:

1.0

Author:

Remko Popma

Constructor Summary

Constructors

Constructor and Description
PicocliRunner()

Method Summary

Modifier and Type	Method and Description
static <C extends Callable<T>,T> T	call(Class<C> cls, ApplicationContext ctx, String... args) Obtains an instance of the specified Callable command class from the specified context, injecting any beans from the specified context as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally calls the command and returns the result.
static <C extends Callable<T>,T> T	call(Class<C> cls, String... args) Instantiates a new ApplicationContext for the Environment.CLI environment, obtains an instance of the specified Callable command class from the context, injecting any beans as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally calls the command and returns the result.
static <R extends Runnable> void	run(Class<R> cls, ApplicationContext ctx, String... args) Obtains an instance of the specified Runnable command class from the specified context, injecting any beans from the specified context as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally runs the command.
static <R extends Runnable> void	run(Class<R> cls, String... args) Instantiates a new ApplicationContext for the Environment.CLI environment, obtains an instance of the specified Runnable command class from the context, injecting any beans as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally runs the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

PicocliRunner

public PicocliRunner()

Method Detail

call

public static <C extends Callable<T>,T> T call(Class<C> cls,
                                               String... args)
                                        throws Exception

Instantiates a new ApplicationContext for the Environment.CLI environment, obtains an instance of the specified Callable command class from the context, injecting any beans as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally calls the command and returns the result.

The ApplicationContext is closed before this method returns.

Type Parameters:

C - The callable type

T - The callable return type

Parameters:

cls - the Callable command class

args - the command line arguments

Returns:

null if an error occurred while parsing the command line options, or if help was requested and printed. Otherwise returns the result of calling the Callable

Throws:

picocli.CommandLine.InitializationException - if the specified command object does not have a CommandLine.Command, CommandLine.Option or CommandLine.Parameters annotation

picocli.CommandLine.ExecutionException - if the Callable throws an exception

Exception - if the ApplicationContext could not be closed

call

public static <C extends Callable<T>,T> T call(Class<C> cls,
                                               ApplicationContext ctx,
                                               String... args)

Obtains an instance of the specified Callable command class from the specified context, injecting any beans from the specified context as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally calls the command and returns the result.

The caller is responsible for closing the context.

Type Parameters:

C - The callable type

T - The callable return type

Parameters:

cls - the Callable command class

ctx - the ApplicationContext that injects dependencies into the command

args - the command line arguments

Returns:

null if an error occurred while parsing the command line options, or if help was requested and printed. Otherwise returns the result of calling the Callable

Throws:

picocli.CommandLine.InitializationException - if the specified command object does not have a CommandLine.Command, CommandLine.Option or CommandLine.Parameters annotation

picocli.CommandLine.ExecutionException - if the Callable throws an exception

run

public static <R extends Runnable> void run(Class<R> cls,
                                            String... args)
                                     throws Exception

Instantiates a new ApplicationContext for the Environment.CLI environment, obtains an instance of the specified Runnable command class from the context, injecting any beans as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally runs the command.

The ApplicationContext is closed before this method returns.

Type Parameters:

R - The runnable type

Parameters:

cls - the Runnable command class

args - the command line arguments

Throws:

picocli.CommandLine.InitializationException - if the specified command object does not have a CommandLine.Command, CommandLine.Option or CommandLine.Parameters annotation

picocli.CommandLine.ExecutionException - if the Runnable throws an exception

Exception - if the ApplicationContext could not be closed

run

public static <R extends Runnable> void run(Class<R> cls,
                                            ApplicationContext ctx,
                                            String... args)

Obtains an instance of the specified Runnable command class from the specified context, injecting any beans from the specified context as required, then parses the specified command line arguments, populating fields and methods annotated with picocli @Option and @Parameters annotations, and finally runs the command.

The caller is responsible for closing the context.

Type Parameters:

R - The runnable type

Parameters:

cls - the Runnable command class

ctx - the ApplicationContext that injects dependencies into the command

args - the command line arguments

Throws:

picocli.CommandLine.InitializationException - if the specified command object does not have a CommandLine.Command, CommandLine.Option or CommandLine.Parameters annotation

picocli.CommandLine.ExecutionException - if the Runnable throws an exception