com.lexicalscope.jewel.cli

Interface Cli<O>

Type Parameters:

O - The type of interface provided by this Cli

public interface Cli<O>

Parses arguments and presents them, in a typesafe style, as an instance of the interface O

Author:

Tim Wood

Method Summary

Methods

Modifier and Type	Method and Description
void	describeTo(HelpMessage helpMessage) BETA: may be removed or altered in future versions Fill in a help message suitable for describing the options to the user
String	getHelpMessage() Get a help message suitable for describing the options to the user
O	parseArguments(String... arguments) Parse the arguments and present them as an instance of the interface O

Method Detail

parseArguments

O parseArguments(String... arguments)
                 throws ArgumentValidationException

Parse the arguments and present them as an instance of the interface O

Parameters:

arguments - The arguments that will be parsed

Returns:

An instance of the interface O which will present the parsed arguments

Throws:

ArgumentValidationException - the arguments do not meet the cli specification

getHelpMessage

String getHelpMessage()

Get a help message suitable for describing the options to the user

Returns:

A help message

describeTo

void describeTo(HelpMessage helpMessage)

BETA: may be removed or altered in future versions Fill in a help message suitable for describing the options to the user