org.pharmgkb.common.io.util

Class CliHelper

java.lang.Object

org.pharmgkb.common.io.util.CliHelper

public class CliHelper
extends java.lang.Object

This is a helper class for command line utilities to deal with command line arguments.

Constructor Summary

Constructors

Constructor and Description
CliHelper(java.lang.Class cls) Standard constructor.

Method Summary

Modifier and Type	Method and Description
CliHelper	addOption(org.apache.commons.cli.Option option)
CliHelper	addOption(java.lang.String shortName, java.lang.String longName, java.lang.String description) Add a boolean option (aka a flag).
CliHelper	addOption(java.lang.String shortName, java.lang.String longName, java.lang.String description, boolean isOptionRequired, java.lang.String argName) Add a required option that takes an argument.
CliHelper	addOption(java.lang.String shortName, java.lang.String longName, java.lang.String description, boolean isOptionRequired, java.lang.String argName, int numArgs, boolean argsAreRequired) Add a required option that takes arguments.
void	execute(java.lang.String[] args, java.util.function.Function<CliHelper,java.lang.Integer> function) Parse arguments and execute the function.
java.util.List	getArguments() Gets remaining parameters.
java.lang.String	getError() Gets the error that occured while parsing arguments.
int	getIntValue(java.lang.String opt) Gets the int value for the given option.
java.nio.file.Path	getPath(java.lang.String opt) Gets the value for the given option as a Path.
java.nio.file.Path	getValidDirectory(java.lang.String opt, boolean createIfNotExist) Gets the value for the given option as a File.
java.nio.file.Path	getValidFile(java.lang.String opt, boolean mustExist) Gets the value for the given option as a Path, that must point to an existing file.
java.lang.String	getValue(java.lang.String opt) Gets the first String value, if any, for the given option.
java.util.List<java.lang.String>	getValues(java.lang.String opt) Gets the String values for the given option.
boolean	hasError() Checks whether the arguments were parsed successfully.
boolean	hasOption(java.lang.String opt) Checks whether the specified option exists.
boolean	isHelpRequested() Gets whether help on command line arguments has been requested.
boolean	isVerbose() Gets whether to operate in verbose mode.
boolean	parse(java.lang.String[] args) Parses arguments.
void	printHelp() Prints the help message.

Methods inherited from class java.lang.Object

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

Constructor Detail

CliHelper

public CliHelper(java.lang.Class cls)

Standard constructor.

Parameters:

cls - the class with the main() method

Method Detail

addOption

public CliHelper addOption(@Nonnull
                           org.apache.commons.cli.Option option)

addOption

public CliHelper addOption(@Nonnull
                           java.lang.String shortName,
                           java.lang.String longName,
                           @Nonnull
                           java.lang.String description)

Add a boolean option (aka a flag).

addOption

public CliHelper addOption(@Nonnull
                           java.lang.String shortName,
                           java.lang.String longName,
                           @Nonnull
                           java.lang.String description,
                           boolean isOptionRequired,
                           @Nonnull
                           java.lang.String argName)

Add a required option that takes an argument.

addOption

public CliHelper addOption(@Nonnull
                           java.lang.String shortName,
                           java.lang.String longName,
                           @Nonnull
                           java.lang.String description,
                           boolean isOptionRequired,
                           @Nonnull
                           java.lang.String argName,
                           int numArgs,
                           boolean argsAreRequired)

Add a required option that takes arguments.

Parameters:

numArgs - 0 if argument(s) are optional, otherwise the number of expected arguments

parse

public boolean parse(java.lang.String[] args)

Parses arguments.

Returns:

true if parse completed and processing should continue, false if there are missing arguments or help was requested

execute

public void execute(java.lang.String[] args,
                    java.util.function.Function<CliHelper,java.lang.Integer> function)

Parse arguments and execute the function. This helps enforce proper exit codes.

hasOption

public boolean hasOption(java.lang.String opt)

Checks whether the specified option exists.

getValue

public java.lang.String getValue(java.lang.String opt)

Gets the first String value, if any, for the given option.

Parameters:

opt - the name of the option

Returns:

Value of the argument if option is set, and has an argument, otherwise null.

getValues

public java.util.List<java.lang.String> getValues(java.lang.String opt)

Gets the String values for the given option.

getIntValue

public int getIntValue(java.lang.String opt)

Gets the int value for the given option.

getValidDirectory

@Nonnull
public java.nio.file.Path getValidDirectory(java.lang.String opt,
                                                      boolean createIfNotExist)
                                               throws java.io.IOException

Gets the value for the given option as a File.

Parameters:

createIfNotExist - if true and directory doesn't exist, create the directory; otherwise, if false and directory doesn't exist, throw IllegalStateException

Returns:

the directory

Throws:

java.lang.IllegalStateException - if directory doesn't exist

java.io.IOException

getPath

@Nonnull
public java.nio.file.Path getPath(@Nonnull
                                            java.lang.String opt)

Gets the value for the given option as a Path.

Throws:

java.lang.IllegalStateException - if option was not specified

getValidFile

@Nonnull
public java.nio.file.Path getValidFile(@Nonnull
                                                 java.lang.String opt,
                                                 boolean mustExist)

Gets the value for the given option as a Path, that must point to an existing file.

Throws:

java.lang.IllegalStateException - if file doesn't exist

getArguments

public java.util.List getArguments()

Gets remaining parameters.

isVerbose

public boolean isVerbose()

Gets whether to operate in verbose mode.

hasError

public boolean hasError()

Checks whether the arguments were parsed successfully.

getError

public java.lang.String getError()

Gets the error that occured while parsing arguments.

isHelpRequested

public boolean isHelpRequested()

Gets whether help on command line arguments has been requested.

printHelp

public void printHelp()

Prints the help message.