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:
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)` The constructor is only intended for internal use.
	`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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`addCommand(java.lang.Object object)`
`void`	`addObject(java.lang.Object... objects)` Add an additional configuration object containing CmdOption-specific annotations to the configuration.
`protected void`	`addOptions(java.lang.Object object)`
`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)` Find a `CmdOptionHandler` for the given element, argument count and requested handler type.
`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 java.util.List<OptionHandle>`	`inspectElements(java.lang.Object object, java.util.Set<java.lang.reflect.AccessibleObject> elements)`
`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)` Parses the given commandline arguments.
`void`	`parse(java.lang.String... cmdline)`
`void`	`registerHandler(CmdOptionHandler handler)` Register a new CmdOptionHandler.
`void`	`setAboutLine(java.lang.String aboutLine)` An additional text displayed at the top of the usage/help display.
`void`	`setAggregateShortOptionsWithPrefix(java.lang.String prefix)` Set the prefix of short options, that should be aggregated.
`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`	`setShortOptionWithArgsPrefix(java.lang.String prefix)` If used to set a non-empty string, this enables the feature to give the argument of a short options without a space.
`void`	`setStopAcceptOptionsAfterParameterIsSet(boolean stopAcceptOptionAfterParameterIsSet)` If set to `true`, the parser will no longer parse options once it has seen a parameter.
`void`	`setUsageFormatter(UsageFormatter2 usageFormatter)`
`void`	`unregisterAllHandler()`
`void`	`unregisterHandler(java.lang.Class<? extends CmdOptionHandler> type)`
`void`	`usage()`
`void`	`usage(java.io.PrintStream output)`
`void`	`usage(java.lang.StringBuilder output)` Deprecated. Use `usage(PrintStream)` instead.
`java.lang.String`	`usageString()`
`void`	`validate()` Check validity of the given configutaion classes.
`protected void`	`validateOptions()` Do a consistency check for the given cmdoption model (all annotated opitons).

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)
```
    The constructor is only intended for internal use. It's used to parse sub-commands.
    
    Parameters:
    
    parent - The parent parser.
    
    commandName - The command name.
    
    commandObject - The target object holding the parsed options.
  - 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(UsageFormatter2 usageFormatter)
```
  - setStopAcceptOptionsAfterParameterIsSet
```
public void setStopAcceptOptionsAfterParameterIsSet(boolean stopAcceptOptionAfterParameterIsSet)
```
    If set to true, the parser will no longer parse options once it has seen a parameter.
    
    Parameters:
    
    stopAcceptOptionAfterParameterIsSet -
    
    Since:
    
    0.7.0
  - 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)
```
    Parses the given commandline arguments.
    If no error were detected and not in dryrun-mode, the result is applied to the config object(s).
    If any errors where detected, they will be thrown as CmdlineParserException.
    
    Parameters:
    
    dryrun - If true, only checks for errors.
    
    detectHelpAndSkipValidation - If true, the given cmdline is first checked for applied help options. In such a case, no other validation errors will be thrown.
    
    cmdline - The commandline argument to be parsed.
    
    Throws:
    
    CmdlineParserException - If any errors were detected.
  - 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)
```
    Find a CmdOptionHandler for the given element, argument count and requested handler type.
    
    Returns:
    
    The found CmdOptionHandler or null.
    
    Throws:
    
    CmdlineParserException - in case an error occured.
  - addObject
```
public void addObject(java.lang.Object... objects)
```
    Add an additional configuration object containing CmdOption-specific annotations to the configuration.
    Classed annotated with CmdCommand are registered as commands, and all found options and parameters are registered to the command.
    
    Parameters:
    
    objects -
    
    Throws:
    
    CmdlineParserException - if the given objects contain configutation errors or are inconsistent.
  - addCommand
```
protected boolean addCommand(java.lang.Object object)
```
  - validate
```
public void validate()
```
    Check validity of the given configutaion classes. You should call this method from a unit test to detect errors and inconsistencies in your configuration.
    
    Throws:
    
    CmdlineParserException - if the configutation is not valid.
    
    Since:
    
    0.6.0
  - validateOptions
```
protected void validateOptions()
```
    Do a consistency check for the given cmdoption model (all annotated opitons).
    
    Throws:
    
    CmdlineParserException - if the configutation is not valid.
  - 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)
```
  - addOptions
```
protected void addOptions(java.lang.Object object)
```
  - inspectElements
```
protected java.util.List<OptionHandle> inspectElements(java.lang.Object object,
                                                       java.util.Set<java.lang.reflect.AccessibleObject> elements)
```
  - 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
```
@Deprecated
public void usage(java.lang.StringBuilder output)
```
    Deprecated. Use usage(PrintStream) instead.
    
    Parameters:
    
    output -
  - usage
```
public void usage(java.io.PrintStream output)
```
  - usageString
```
public java.lang.String usageString()
```
  - 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. Typically a "@"
    
    Since:
    
    CmdOption 0.4.0
  - setAggregateShortOptionsWithPrefix
```
public void setAggregateShortOptionsWithPrefix(java.lang.String prefix)
```
    Set the prefix of short options, that should be aggregated.
    
    Parameters:
    
    prefix - The prefix, typically a "-". If null or the empty string, this short option aggregation is disabled
    
    Since:
    
    CmdOption 0.5.0
  - setShortOptionWithArgsPrefix
```
public void setShortOptionWithArgsPrefix(java.lang.String prefix)
```
    If used to set a non-empty string, this enables the feature to give the argument of a short options without a space.
    
    Parameters:
    
    prefix - The prefix denoting a short options that accepts its argument without a space, typically a "-"
    
    Since:
    
    CmdOption 0.7.1

Class CmdlineParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CmdlineParser

CmdlineParser

Method Detail

defaultHandlers

setDebugMode

setDebugModeAllowed

setUsageFormatter

setStopAcceptOptionsAfterParameterIsSet

setDefaultCommandName

setDefaultCommandClass

parse

parse

getParsedCommandName

getParsedCommandObject

findHandler

addObject

addCommand

validate

validateOptions

isVisible

isPublicOrProtected

isPackagePrivate

isPrivate

containsMethod

findMethod

addOptions

inspectElements

unregisterAllHandler

unregisterHandler

registerHandler

commandUsage

usage

usage

usage

usageString

getCmdlineModel

setProgramName

setAboutLine

setResourceBundle

setResourceBundle

setResourceBundle

setReadArgsFromFilePrefix

setAggregateShortOptionsWithPrefix

setShortOptionWithArgsPrefix