de.tototec.cmdoption

Class CmdlineParser

java.lang.Object

de.tototec.cmdoption.CmdlineParser

public class CmdlineParser
extends java.lang.Object

CmdOption main entry point to configure the parser, parse the command line and provide help. The central method to parse a command line is parse(String...). The command line will be parsed and validated based on configuration objects which are annotated with CmdOption-specific annotations, which are:

• CmdOption
• CmdCommand
• CmdOptionDelegate

Each parsed option will be directly applied to the corresponding method or field. The configuration objects are typically provided as constructor arguments, but it is also possible to use the addObject(Object...) method to add additional configuration objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CmdlineParser(CmdlineParser parent, java.lang.String commandName, java.lang.Object commandObject)
	CmdlineParser(java.lang.Object... objects) Create a new commandline parser instance and scan all given object for supported options, parameters and commands using the pre-registered default handlers.

Method Summary

Modifier and Type	Method and Description
void	addObject(java.lang.Object... objects) Add an additional configuration object containing CmdOption-specific annotations to the configuration.
void	commandUsage(java.lang.Class<?> command)
protected boolean	containsMethod(java.lang.Iterable<java.lang.reflect.Method> methods, java.lang.reflect.Method method)
java.util.List<CmdOptionHandler>	defaultHandlers()
protected CmdOptionHandler	findHandler(java.lang.reflect.AccessibleObject element, int argsCount, java.lang.Class<? extends CmdOptionHandler> cmdOptionHandlerType)
protected java.lang.reflect.Method	findMethod(java.lang.Iterable<java.lang.reflect.Method> methods, java.lang.reflect.Method method)
CmdlineModel	getCmdlineModel()
java.lang.String	getParsedCommandName()
java.lang.Object	getParsedCommandObject()
protected boolean	isPackagePrivate(java.lang.reflect.Method method)
protected boolean	isPrivate(java.lang.reflect.Method method)
protected boolean	isPublicOrProtected(java.lang.reflect.Method method)
protected boolean	isVisible(java.lang.Class<?> baseClass, java.lang.reflect.Member element)
void	parse(boolean dryrun, boolean detectHelpAndSkipValidation, java.lang.String... cmdline)
void	parse(java.lang.String... cmdline)
void	registerHandler(CmdOptionHandler handler) Register a new CmdOptionHandler.
protected void	scanCommand(java.lang.Object object)
protected void	scanOptions(java.lang.Object object)
void	setAboutLine(java.lang.String aboutLine) An additional text displayed at the top of the usage/help display.
void	setDebugMode(boolean debugMode) Programmatically enable or disable the debug mode.
void	setDebugModeAllowed(boolean debugAllowed) Allow or disallow the recognition of a request of the debug mode via the special command line option --CMDOPTION_DEBUG.
void	setDefaultCommandClass(java.lang.Class<?> defaultCommandClass)
void	setDefaultCommandName(java.lang.String defaultCommandName)
void	setProgramName(java.lang.String programName) Set the name of the program is usually called on the command line.
void	setReadArgsFromFilePrefix(java.lang.String prefix) Set the argument prefix used to mark a cmdline argument as file which contains more commandline parameters.
void	setResourceBundle(java.util.ResourceBundle resourceBundle)
void	setResourceBundle(java.lang.String resourceBundleName, java.lang.ClassLoader classloader)
void	setResourceBundle(java.lang.String resourceBundleName, java.util.Locale locale, java.lang.ClassLoader classloader)
void	setUsageFormatter(UsageFormatter usageFormatter)
void	unregisterAllHandler()
void	unregisterHandler(java.lang.Class<? extends CmdOptionHandler> type)
void	usage()
void	usage(java.lang.StringBuilder output)
protected void	validateOptions()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdlineParser

protected CmdlineParser(CmdlineParser parent,
                        java.lang.String commandName,
                        java.lang.Object commandObject)

CmdlineParser

public CmdlineParser(java.lang.Object... objects)

Create a new commandline parser instance and scan all given object for supported options, parameters and commands using the pre-registered default handlers. Please note that if you want to use a custom set of option handlers, you should not give your config objects here but use the addObject(Object...) method after you registered the desired set of handlers.

Parameters:

objects - The configuration objects containing supported annotations.

Method Detail

defaultHandlers

public java.util.List<CmdOptionHandler> defaultHandlers()

setDebugMode

public void setDebugMode(boolean debugMode)

Programmatically enable or disable the debug mode.

setDebugModeAllowed

public void setDebugModeAllowed(boolean debugAllowed)

Allow or disallow the recognition of a request of the debug mode via the special command line option --CMDOPTION_DEBUG.

setUsageFormatter

public void setUsageFormatter(UsageFormatter usageFormatter)

setDefaultCommandName

public void setDefaultCommandName(java.lang.String defaultCommandName)

setDefaultCommandClass

public void setDefaultCommandClass(java.lang.Class<?> defaultCommandClass)

parse

public void parse(java.lang.String... cmdline)

parse

public void parse(boolean dryrun,
                  boolean detectHelpAndSkipValidation,
                  java.lang.String... cmdline)

getParsedCommandName

public java.lang.String getParsedCommandName()

getParsedCommandObject

public java.lang.Object getParsedCommandObject()

findHandler

protected CmdOptionHandler findHandler(java.lang.reflect.AccessibleObject element,
                                       int argsCount,
                                       java.lang.Class<? extends CmdOptionHandler> cmdOptionHandlerType)

addObject

public void addObject(java.lang.Object... objects)

Add an additional configuration object containing CmdOption-specific annotations to the configuration.

Parameters:

objects -

scanCommand

protected void scanCommand(java.lang.Object object)

validateOptions

protected void validateOptions()

isVisible

protected boolean isVisible(java.lang.Class<?> baseClass,
                            java.lang.reflect.Member element)

isPublicOrProtected

protected boolean isPublicOrProtected(java.lang.reflect.Method method)

isPackagePrivate

protected boolean isPackagePrivate(java.lang.reflect.Method method)

isPrivate

protected boolean isPrivate(java.lang.reflect.Method method)

containsMethod

protected boolean containsMethod(java.lang.Iterable<java.lang.reflect.Method> methods,
                                 java.lang.reflect.Method method)

findMethod

protected java.lang.reflect.Method findMethod(java.lang.Iterable<java.lang.reflect.Method> methods,
                                              java.lang.reflect.Method method)

scanOptions

protected void scanOptions(java.lang.Object object)

unregisterAllHandler

public void unregisterAllHandler()

unregisterHandler

public void unregisterHandler(java.lang.Class<? extends CmdOptionHandler> type)

registerHandler

public void registerHandler(CmdOptionHandler handler)

Register a new CmdOptionHandler. Please note: The newly registered handlers will only have an effect to succeeding calls to addObject(Object...).

commandUsage

public void commandUsage(java.lang.Class<?> command)

usage

public void usage()

usage

public void usage(java.lang.StringBuilder output)

getCmdlineModel

public CmdlineModel getCmdlineModel()

setProgramName

public void setProgramName(java.lang.String programName)

Set the name of the program is usually called on the command line.

setAboutLine

public void setAboutLine(java.lang.String aboutLine)

An additional text displayed at the top of the usage/help display.

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundleName,
                              java.lang.ClassLoader classloader)

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundleName,
                              java.util.Locale locale,
                              java.lang.ClassLoader classloader)

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resourceBundle)

setReadArgsFromFilePrefix

public void setReadArgsFromFilePrefix(java.lang.String prefix)

Set the argument prefix used to mark a cmdline argument as file which contains more commandline parameters. If not changed, this is by default the "@" sign. You can also disable this feature by setting null or the empty string. The file contains additional arguments, each one on a new line.

Parameters:

prefix - The prefix to mark an argument as arguments-file or null to disable the feature.