Package cdc.util.cli

Class AbstractMainSupport<A,R>

java.lang.Object

cdc.util.cli.AbstractMainSupport<A,R>

Type Parameters:

A - MainArgs type.

R - Returned type.

public abstract class AbstractMainSupport<A,R>
extends java.lang.Object

Utility that can be used to create main programs.

The purpose is to force the adoption of a common pattern for such classes.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractMainSupport.Maskable<E extends java.lang.Enum<E>>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CHARSET
static java.lang.String	DEFAULT_PARTS_SEPARATOR
static java.lang.String	DRIVER
static java.lang.String	HELP
static java.lang.String	INPUT
static java.lang.String	INPUT_DIR
static java.lang.String	OUTPUT
static java.lang.String	OUTPUT_DIR
static java.lang.String	PASSWORD
static java.lang.String	PATH
static java.lang.String	PREFIX
static java.lang.String	TMP_DIR
static java.lang.String	URL
static java.lang.String	USER
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMainSupport(java.lang.Class<?> mainClass, org.apache.logging.log4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
static <E extends java.lang.Enum<E> & OptionEnum> void	addNoArgOptions(org.apache.commons.cli.Options options, java.lang.Class<E> enumClass)
protected abstract void	addSpecificOptions(org.apache.commons.cli.Options options)	Creates specific options and add them to an options collection.
protected void	addStandardOptions(org.apache.commons.cli.Options options)
protected abstract A	analyze(org.apache.commons.cli.CommandLine cl)	Analyzes the command line.
protected org.apache.commons.cli.Options	buildOptions()	Creates options, add standard and specific options and returns them.
static <E extends java.lang.Enum<E> & OptionEnum> void	createGroup(org.apache.commons.cli.Options options, E... values)
protected abstract R	execute(A margs)	Executes the main program.
static void	fillValues(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.util.Collection<java.lang.String> values)
static <T> void	fillValues(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.util.Collection<T> values, java.util.function.Function<java.lang.String,T> converter)
protected java.lang.String	getHelpFooter()	Returns the help footer.
protected java.lang.String	getHelpHeader()	Returns the help header.
protected org.apache.logging.log4j.Logger	getLogger()
protected org.apache.commons.cli.Options	getOptionsAsOptional()
static java.lang.String	getPart1(java.lang.String s)	Returns the part of a string that is before DEFAULT_PARTS_SEPARATOR.
static java.lang.String	getPart1(java.lang.String s, java.lang.String sep)	Returns the part of a string that is before a separator.
static java.lang.String	getPart2(java.lang.String s, java.lang.String def)	Returns the part of a string that is after DEFAULT_PARTS_SEPARATOR.
static java.lang.String	getPart2(java.lang.String s, java.lang.String sep, java.lang.String def)	Returns the part of a string that is after a separator.
static <T> T	getValue(org.apache.commons.cli.CommandLine cl, java.lang.String opt, T def, java.util.function.Function<java.lang.String,T> converter)
static byte	getValueAsByte(org.apache.commons.cli.CommandLine cl, java.lang.String opt, byte def)	Returns an option value as a byte.
static char	getValueAsChar(org.apache.commons.cli.CommandLine cl, java.lang.String opt, char def)	Returns an option value as a char.
static java.io.File	getValueAsDirectory(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)
static double	getValueAsDouble(org.apache.commons.cli.CommandLine cl, java.lang.String opt, double def)	Returns an option value as a double.
static <E extends java.lang.Enum<E>> E	getValueAsEnum(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.lang.Class<E> enumClass, E def)	Returns an option value as a enum.
static java.io.File	getValueAsExistingDirectory(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)
static java.io.File	getValueAsExistingFile(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)
static java.io.File	getValueAsExistingFileOrDirectory(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)
static java.io.File	getValueAsFile(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)	Returns an option value as a File.
static float	getValueAsFloat(org.apache.commons.cli.CommandLine cl, java.lang.String opt, float def)	Returns an option value as a float.
static int	getValueAsInt(org.apache.commons.cli.CommandLine cl, java.lang.String opt, int def)	Returns an option value as an int.
static long	getValueAsLong(org.apache.commons.cli.CommandLine cl, java.lang.String opt, long def)	Returns an option value as a long.
static java.io.File	getValueAsNullOrExistingDirectory(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)	Returns an option value as an existing directory or null.
static java.io.File	getValueAsNullOrExistingFile(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)	Returns an option value as an existing file or null.
static java.io.File	getValueAsNullOrExistingFileOrDirectory(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.io.File def)	Returns an option value as an existing file or directory or null.
static short	getValueAsShort(org.apache.commons.cli.CommandLine cl, java.lang.String opt, short def)	Returns an option value as a short.
static java.lang.String	getValueAsString(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.lang.String def)	Returns an option value as a string.
static java.net.URL	getValueAsURL(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.net.URL def)	Returns an option value as an URL.
static <T> java.util.List<T>	getValues(org.apache.commons.cli.CommandLine cl, java.lang.String opt, java.util.function.Function<java.lang.String,T> converter)
protected java.lang.String	getVersion()	Returns the version.
R	main(java.lang.String[] args)	Default main program.
protected void	printHelp(org.apache.commons.cli.Options options, java.lang.Exception e)
protected void	printVersion()
static <E extends java.lang.Enum<E> & OptionEnum> void	setMask(org.apache.commons.cli.CommandLine cl, java.lang.Class<E> enumClass, AbstractMainSupport.Maskable<E> maskable)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PARTS_SEPARATOR

public static final java.lang.String DEFAULT_PARTS_SEPARATOR

See Also:

Constant Field Values

CHARSET

public static final java.lang.String CHARSET

See Also:

Constant Field Values

DRIVER

public static final java.lang.String DRIVER

See Also:

Constant Field Values

HELP

public static final java.lang.String HELP

See Also:

Constant Field Values

INPUT

public static final java.lang.String INPUT

See Also:

Constant Field Values

INPUT_DIR

public static final java.lang.String INPUT_DIR

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

See Also:

Constant Field Values

OUTPUT_DIR

public static final java.lang.String OUTPUT_DIR

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

TMP_DIR

public static final java.lang.String TMP_DIR

See Also:

Constant Field Values

URL

public static final java.lang.String URL

See Also:

Constant Field Values

USER

public static final java.lang.String USER

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

AbstractMainSupport

protected AbstractMainSupport(java.lang.Class<?> mainClass,
                              org.apache.logging.log4j.Logger logger)

Method Detail

addStandardOptions

protected void addStandardOptions(org.apache.commons.cli.Options options)

getLogger

protected final org.apache.logging.log4j.Logger getLogger()

getVersion

protected java.lang.String getVersion()

Returns the version.

If null is returned (default implementation), no version option is available.

Returns:

The version.

getHelpHeader

protected java.lang.String getHelpHeader()

Returns the help header.

If null is returned (default implementation), no help header is printed.

Returns:

The help header.

getHelpFooter

protected java.lang.String getHelpFooter()

Returns the help footer.

If null is returned (default implementation), no help footer is printed.

Returns:

The help footer.

addSpecificOptions

protected abstract void addSpecificOptions(org.apache.commons.cli.Options options)

Creates specific options and add them to an options collection.

The standard options must not be added.

Parameters:

options - The options.

analyze

protected abstract A analyze(org.apache.commons.cli.CommandLine cl)
                      throws org.apache.commons.cli.ParseException

Analyzes the command line.

The help option does not need to be analyzed.

Parameters:

cl - The command line.

Returns:

A MainARgs instance.

Throws:

org.apache.commons.cli.ParseException - When command line parsing has a problem.

execute

protected abstract R execute(A margs)
                      throws java.lang.Exception

Executes the main program.

Parameters:

margs - The main arguments.

Returns:

The optional result.

Throws:

java.lang.Exception - When program has a problem.

addNoArgOptions

public static <E extends java.lang.Enum<E> & OptionEnum> void addNoArgOptions(org.apache.commons.cli.Options options,
                                                                              java.lang.Class<E> enumClass)

createGroup

@SafeVarargs
public static <E extends java.lang.Enum<E> & OptionEnum> void createGroup(org.apache.commons.cli.Options options,
                                                                          E... values)

setMask

public static <E extends java.lang.Enum<E> & OptionEnum> void setMask(org.apache.commons.cli.CommandLine cl,
                                                                      java.lang.Class<E> enumClass,
                                                                      AbstractMainSupport.Maskable<E> maskable)

main

public R main(java.lang.String[] args)

Default main program.

This does the following things:

1. Build options
2. Parse the command line strings and creates a CommandLine instance.
3. Analyze the CommandLine instance and create a MainArgs instance
4. Calls execute with the MainARgs instance.

Parameters:

args - The command line arguments.

Returns:

The optional result.

buildOptions

protected org.apache.commons.cli.Options buildOptions()

Creates options, add standard and specific options and returns them.

Returns:

The options.

getOptionsAsOptional

protected org.apache.commons.cli.Options getOptionsAsOptional()

printHelp

protected void printHelp(org.apache.commons.cli.Options options,
                         java.lang.Exception e)

printVersion

protected void printVersion()

getValue

public static <T> T getValue(org.apache.commons.cli.CommandLine cl,
                             java.lang.String opt,
                             T def,
                             java.util.function.Function<java.lang.String,T> converter)
                      throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

fillValues

public static void fillValues(org.apache.commons.cli.CommandLine cl,
                              java.lang.String opt,
                              java.util.Collection<java.lang.String> values)

fillValues

public static <T> void fillValues(org.apache.commons.cli.CommandLine cl,
                                  java.lang.String opt,
                                  java.util.Collection<T> values,
                                  java.util.function.Function<java.lang.String,T> converter)
                           throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

getValues

public static <T> java.util.List<T> getValues(org.apache.commons.cli.CommandLine cl,
                                              java.lang.String opt,
                                              java.util.function.Function<java.lang.String,T> converter)
                                       throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

getValueAsFile

public static java.io.File getValueAsFile(org.apache.commons.cli.CommandLine cl,
                                          java.lang.String opt,
                                          java.io.File def)
                                   throws org.apache.commons.cli.ParseException

Returns an option value as a File.

If option is absent, returns a default value.
Result is null only when option does not exist and default value is null.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a File.

Throws:

org.apache.commons.cli.ParseException - If result could not be produced.

getValueAsExistingFile

public static java.io.File getValueAsExistingFile(org.apache.commons.cli.CommandLine cl,
                                                  java.lang.String opt,
                                                  java.io.File def)
                                           throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

getValueAsDirectory

public static java.io.File getValueAsDirectory(org.apache.commons.cli.CommandLine cl,
                                               java.lang.String opt,
                                               java.io.File def)
                                        throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

getValueAsNullOrExistingFile

public static java.io.File getValueAsNullOrExistingFile(org.apache.commons.cli.CommandLine cl,
                                                        java.lang.String opt,
                                                        java.io.File def)
                                                 throws org.apache.commons.cli.ParseException

Returns an option value as an existing file or null.

If option is absent, returns a default value (possibly null).
If result is not null and does not exist as a file, throws an exception.
To obtain a null result :

• default value must be set to null.
• option must be absent.

Parameters:

cl - The command line.

opt - The option name.

def - Default value. MAY BE null.

Returns:

The option value or default value. Is either an existing file or null.

Throws:

org.apache.commons.cli.ParseException - If result is not null and does not exist.

getValueAsExistingDirectory

public static java.io.File getValueAsExistingDirectory(org.apache.commons.cli.CommandLine cl,
                                                       java.lang.String opt,
                                                       java.io.File def)
                                                throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

getValueAsNullOrExistingDirectory

public static java.io.File getValueAsNullOrExistingDirectory(org.apache.commons.cli.CommandLine cl,
                                                             java.lang.String opt,
                                                             java.io.File def)
                                                      throws org.apache.commons.cli.ParseException

Returns an option value as an existing directory or null.

If option is absent, returns a default value (possibly null).
If result is not null and does not exist as a directory, throws an exception.
To obtain a null result :

• default value must be set to null.
• option must be absent.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value or default value. Is either an existing directory or null.

Throws:

org.apache.commons.cli.ParseException - If result is not null and does not exist.

getValueAsExistingFileOrDirectory

public static java.io.File getValueAsExistingFileOrDirectory(org.apache.commons.cli.CommandLine cl,
                                                             java.lang.String opt,
                                                             java.io.File def)
                                                      throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

getValueAsNullOrExistingFileOrDirectory

public static java.io.File getValueAsNullOrExistingFileOrDirectory(org.apache.commons.cli.CommandLine cl,
                                                                   java.lang.String opt,
                                                                   java.io.File def)
                                                            throws org.apache.commons.cli.ParseException

Returns an option value as an existing file or directory or null.

If option is absent, returns a default value (possibly null).
If result is not null and does not exist as a file or directory, throws an exception.
To obtain a null result :

• default value must be set to null.
• option must be absent.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value or default value. Is either an existing file or directory or null.

Throws:

org.apache.commons.cli.ParseException - If result is not null and does not exist.

getValueAsURL

public static java.net.URL getValueAsURL(org.apache.commons.cli.CommandLine cl,
                                         java.lang.String opt,
                                         java.net.URL def)
                                  throws org.apache.commons.cli.ParseException

Returns an option value as an URL.

If option is absent, returns a default value (possibly null).
If option is present and can be converted to an URL, returns this conversion.
Otherwise, raises an exception.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value or default value.

Throws:

org.apache.commons.cli.ParseException - If option is present and can not be converted to a valid URL.

getValueAsString

public static java.lang.String getValueAsString(org.apache.commons.cli.CommandLine cl,
                                                java.lang.String opt,
                                                java.lang.String def)

Returns an option value as a string.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a string.

getValueAsChar

public static char getValueAsChar(org.apache.commons.cli.CommandLine cl,
                                  java.lang.String opt,
                                  char def)
                           throws org.apache.commons.cli.ParseException

Returns an option value as a char.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a char.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as a char.

getValueAsLong

public static long getValueAsLong(org.apache.commons.cli.CommandLine cl,
                                  java.lang.String opt,
                                  long def)
                           throws org.apache.commons.cli.ParseException

Returns an option value as a long.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a long.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as a long.

getValueAsInt

public static int getValueAsInt(org.apache.commons.cli.CommandLine cl,
                                java.lang.String opt,
                                int def)
                         throws org.apache.commons.cli.ParseException

Returns an option value as an int.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as an int.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as an int.

getValueAsShort

public static short getValueAsShort(org.apache.commons.cli.CommandLine cl,
                                    java.lang.String opt,
                                    short def)
                             throws org.apache.commons.cli.ParseException

Returns an option value as a short.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a short.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as a short.

getValueAsByte

public static byte getValueAsByte(org.apache.commons.cli.CommandLine cl,
                                  java.lang.String opt,
                                  byte def)
                           throws org.apache.commons.cli.ParseException

Returns an option value as a byte.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a byte.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as a byte.

getValueAsDouble

public static double getValueAsDouble(org.apache.commons.cli.CommandLine cl,
                                      java.lang.String opt,
                                      double def)
                               throws org.apache.commons.cli.ParseException

Returns an option value as a double.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a double.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as a double.

getValueAsFloat

public static float getValueAsFloat(org.apache.commons.cli.CommandLine cl,
                                    java.lang.String opt,
                                    float def)
                             throws org.apache.commons.cli.ParseException

Returns an option value as a float.

If option is absent, returns a default value.

Parameters:

cl - The command line.

opt - The option name.

def - Default value.

Returns:

The option value as a float.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as a float.

getValueAsEnum

public static <E extends java.lang.Enum<E>> E getValueAsEnum(org.apache.commons.cli.CommandLine cl,
                                                             java.lang.String opt,
                                                             java.lang.Class<E> enumClass,
                                                             E def)
                                                      throws org.apache.commons.cli.ParseException

Returns an option value as a enum.

If option is absent, returns a default value.

Type Parameters:

E - The enum type.

Parameters:

cl - The command line.

opt - The option name.

enumClass - Enum class

def - Default value.

Returns:

The option value as an enum.

Throws:

org.apache.commons.cli.ParseException - If the option value can not be parsed as an enum value.

getPart1

public static java.lang.String getPart1(java.lang.String s,
                                        java.lang.String sep)

Returns the part of a string that is before a separator.

Parameters:

s - The string.

sep - The separator.

Returns:

The part of s that is before sep or s if sep is not found.

getPart1

public static java.lang.String getPart1(java.lang.String s)

Returns the part of a string that is before DEFAULT_PARTS_SEPARATOR.

Parameters:

s - The string.

Returns:

The part of s that is before DEFAULT_PARTS_SEPARATOR or s if separator is not found.

getPart2

public static java.lang.String getPart2(java.lang.String s,
                                        java.lang.String sep,
                                        java.lang.String def)

Returns the part of a string that is after a separator.

Parameters:

s - The string.

sep - The separator.

def - The default value.

Returns:

The part of s that is after sep or def if sep is not found.

getPart2

public static java.lang.String getPart2(java.lang.String s,
                                        java.lang.String def)

Returns the part of a string that is after DEFAULT_PARTS_SEPARATOR.

Parameters:

s - The string.

def - The default value.

Returns:

The part of s that is after DEFAULT_PARTS_SEPARATOR or def if separator is not found.