CommandLineParser (Groovy Documentation)

Summary:
Constructor
Method

| Detail:
Constructor
Method

org.exoplatform.platform.am.cli.CommandLineParser

Parser for command line arguments
Authors:
Arnaud Héritier

Constructor Summary

Constructors
Constructor and description
`CommandLineParser (java.lang.String scriptName, int columnSize)` Default Constructor

Methods Summary

Methods
Type	Name and description
`CommandLineParameters`	`parse(java.lang.String[] args)` Initialize settings from command line parameters
`void`	`usage()` Display in the output the usage message to explain how to use the program and its parameters

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - CommandLineParser(java.lang.String scriptName, int columnSize)
    
    Default Constructor
    Parameters:
    scriptName - The name of the script (used to display usage message)
    columnSize - The number of characters to in an output line (used to display usage message)
- Method Detail
  - CommandLineParameters parse(java.lang.String[] args)
    
    Initialize settings from command line parameters
    thows:
    CommandLineParsingException if something goes wrong while analyzing CL parameters
    
    Parameters:
    args - Command line parameters to analyze
    Returns:
    a CommandLineParameters instance populated with data coming from the command line
  - void usage()
    
    Display in the output the usage message to explain how to use the program and its parameters

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation