Vert.x 4.5.13 · io.vertx.core.cli.impl.DefaultParser

Modifier and Type	Field and Description
private CLI	cli
private DefaultCommandLine	commandLine
protected Option	current
protected List<Option>	expectedOpts
private boolean	skipParsing
protected String	token

Access	Constructor and Description
public	DefaultParser()

Method Summary

Modifier and Type	Method and Description
private void	checkRequiredOptions()
private void	checkRequiredValues()
private String	Returns: the found prefix. getLongPrefix(String the token token) Search for a prefix that is the long name of an option (-Xmx512m)
public List<Option>	Returns: the options matching the partial name specified, or an empty list if none matches getMatchingOptions(String the partial name of the option opt) Returns the options with a long name starting with the name specified.
public Option	Returns: the option represented by opt getOption(String short or long name of the `Option` opt) Retrieve the `Option` matching the long or short name specified.
private List<Option>	getRequiredOptions()
private void	handleArgument(String token)
protected void	handleConcatenatedOptions(String token)
private void	handleLongOption(String the command line token to handle token) Handles the following tokens: --L --L=V --L V --l
private void	handleLongOptionWithEqual(String the command line token to handle token) Handles the following tokens: --L=V -L=V --l=V -l=V
private void	handleLongOptionWithoutEqual(String the command line token to handle token) Handles the following tokens: --L -L --l -l
private void	handleOption(Option option)
private void	handleShortAndLongOption(String the command line token to handle token) Handles the following tokens: -S -SV -S V -S=V -L -LV -L V -L=V -l
private boolean	hasOptionWithLongName(String name)
private boolean	hasOptionWithShortName(String name)
private boolean	isAValidShortOption(String token)
private boolean	Returns: `true` if the token represents an option (long name match) isLongOption(String the token token) Tells if the token looks like a long option.
private boolean	Returns: `true` if the token represents a negative number isNegativeNumber(String the token token) Check if the token is a negative number.
private boolean	Returns: `true` if the token represents an option isOption(String the token token) Tells if the token looks like an option.
private boolean	Returns: `true` if the token represents an option (short name match) isShortOption(String the token token) Tells if the token looks like a short option.
private boolean	Returns: `true` if the token represents a value isValue(String the token token) Returns true is the token is a valid value.
public CommandLine	parse(CLI cli, List<String> cla)
public CommandLine	parse(CLI cli, List<String> cla, boolean validate)
pack-priv static String	Returns: The string without the leading and trailing quotes. stripLeadingAndTrailingQuotes(String The string from which the leading and trailing quotes should be removed. str) Remove the leading and trailing quotes from `str`.
pack-priv static String	Returns: the new String. stripLeadingHyphens(String The string from which the hyphens should be removed. str) Remove the hyphens from the beginning of `str` and return the new String.
private void	updateRequiredOptions(Option the option option) Removes the option from the list of expected elements.
protected void	validate()
private void	visit(String token)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

cli	back to summary
private CLI cli

commandLine	back to summary
private DefaultCommandLine commandLine

current	back to summary
protected Option current

expectedOpts	back to summary
protected List<Option> expectedOpts

skipParsing	back to summary
private boolean skipParsing

token	back to summary
protected String token

DefaultParser	back to summary
public DefaultParser()

Method Detail

checkRequiredOptions	back to summary
private void checkRequiredOptions() throws MissingOptionException

checkRequiredValues	back to summary
private void checkRequiredValues() throws MissingValueException

getLongPrefix	back to summary
private String getLongPrefix(String token) Search for a prefix that is the long name of an option (-Xmx512m) Parameters token:String the token Returns:String the found prefix.

getLongPrefix

back to summary

private String getLongPrefix(String token)

Search for a prefix that is the long name of an option (-Xmx512m)

Parameters

token:String: the token

Returns:String

the found prefix.

getMatchingOptions	back to summary
public List<Option> getMatchingOptions(String opt) Returns the options with a long name starting with the name specified. Parameters opt:String the partial name of the option Returns:List<Option> the options matching the partial name specified, or an empty list if none matches

getMatchingOptions

back to summary

public List<Option> getMatchingOptions(String opt)

Returns the options with a long name starting with the name specified.

Parameters

opt:String: the partial name of the option

Returns:List<Option>

the options matching the partial name specified, or an empty list if none matches

getOption back to summary

getOption	back to summary
public Option getOption(String opt) Retrieve the `Option` matching the long or short name specified. The leading hyphens in the name are ignored (up to 2). Parameters opt:String short or long name of the `Option` Returns:Option the option represented by opt

public Option getOption(String opt)

Retrieve the Option matching the long or short name specified. The leading hyphens in the name are ignored (up to 2).

Parameters

opt:String: short or long name of the Option

Returns:Option

the option represented by opt

getRequiredOptions	back to summary
private List<Option> getRequiredOptions()

handleArgument	back to summary
private void handleArgument(String token)

handleConcatenatedOptions	back to summary
protected void handleConcatenatedOptions(String token) throws CLIException

handleLongOption	back to summary
private void handleLongOption(String token) throws CLIException Handles the following tokens: --L --L=V --L V --l Parameters token:String the command line token to handle

handleLongOption

back to summary

private void handleLongOption(String token) throws CLIException

Handles the following tokens:

--L --L=V --L V --l

Parameters

token:String: the command line token to handle

handleLongOptionWithEqual	back to summary
private void handleLongOptionWithEqual(String token) throws CLIException Handles the following tokens: --L=V -L=V --l=V -l=V Parameters token:String the command line token to handle

handleLongOptionWithEqual

back to summary

private void handleLongOptionWithEqual(String token) throws CLIException

Handles the following tokens:

--L=V -L=V --l=V -l=V

Parameters

token:String: the command line token to handle

handleLongOptionWithoutEqual	back to summary
private void handleLongOptionWithoutEqual(String token) throws CLIException Handles the following tokens: --L -L --l -l Parameters token:String the command line token to handle

handleLongOptionWithoutEqual

back to summary

private void handleLongOptionWithoutEqual(String token) throws CLIException

Handles the following tokens:

--L -L --l -l

Parameters

token:String: the command line token to handle

handleOption	back to summary
private void handleOption(Option option) throws CLIException

handleShortAndLongOption	back to summary
private void handleShortAndLongOption(String token) throws CLIException Handles the following tokens: -S -SV -S V -S=V -L -LV -L V -L=V -l Parameters token:String the command line token to handle

handleShortAndLongOption

back to summary

private void handleShortAndLongOption(String token) throws CLIException

Handles the following tokens:

-S -SV -S V -S=V

-L -LV -L V -L=V -l

Parameters

token:String: the command line token to handle

hasOptionWithLongName	back to summary
private boolean hasOptionWithLongName(String name)

hasOptionWithShortName	back to summary
private boolean hasOptionWithShortName(String name)

isAValidShortOption	back to summary
private boolean isAValidShortOption(String token)

isLongOption back to summary

isLongOption	back to summary
private boolean isLongOption(String token) Tells if the token looks like a long option. Parameters token:String the token Returns:boolean `true` if the token represents an option (long name match)

private boolean isLongOption(String token)

Tells if the token looks like a long option.

Parameters

token:String: the token

Returns:boolean

true if the token represents an option (long name match)

isNegativeNumber back to summary

isNegativeNumber	back to summary
private boolean isNegativeNumber(String token) Check if the token is a negative number. Parameters token:String the token Returns:boolean `true` if the token represents a negative number Annotations @SuppressWarnings:ResultOfMethodCallIgnored

private boolean isNegativeNumber(String token)

Check if the token is a negative number.

Parameters

token:String: the token

Returns:boolean

true if the token represents a negative number

Annotations

@SuppressWarnings:ResultOfMethodCallIgnored

isOption back to summary

isOption	back to summary
private boolean isOption(String token) Tells if the token looks like an option. Parameters token:String the token Returns:boolean `true` if the token represents an option

private boolean isOption(String token)

Tells if the token looks like an option.

Parameters

token:String: the token

Returns:boolean

true if the token represents an option

isShortOption back to summary

isShortOption	back to summary
private boolean isShortOption(String token) Tells if the token looks like a short option. Parameters token:String the token Returns:boolean `true` if the token represents an option (short name match)

private boolean isShortOption(String token)

Tells if the token looks like a short option.

Parameters

token:String: the token

Returns:boolean

true if the token represents an option (short name match)

isValue back to summary

isValue	back to summary
private boolean isValue(String token) Returns true is the token is a valid value. Parameters token:String the token Returns:boolean `true` if the token represents a value

private boolean isValue(String token)

Returns true is the token is a valid value.

Parameters

token:String: the token

Returns:boolean

true if the token represents a value

parse	back to summary
public CommandLine parse(CLI cli, List<String> cla) throws CLIException

parse	back to summary
public CommandLine parse(CLI cli, List<String> cla, boolean validate) throws CLIException

stripLeadingAndTrailingQuotes back to summary

stripLeadingAndTrailingQuotes	back to summary
pack-priv static String stripLeadingAndTrailingQuotes(String str) Remove the leading and trailing quotes from `str`. E.g. if str is '"one two"', then 'one two' is returned. Parameters str:String The string from which the leading and trailing quotes should be removed. Returns:String The string without the leading and trailing quotes.

pack-priv static String stripLeadingAndTrailingQuotes(String str)

Remove the leading and trailing quotes from str. E.g. if str is '"one two"', then 'one two' is returned.

Parameters

str:String: The string from which the leading and trailing quotes should be removed.

Returns:String

The string without the leading and trailing quotes.

stripLeadingHyphens back to summary

stripLeadingHyphens	back to summary
pack-priv static String stripLeadingHyphens(String str) Remove the hyphens from the beginning of `str` and return the new String. Parameters str:String The string from which the hyphens should be removed. Returns:String the new String.

pack-priv static String stripLeadingHyphens(String str)

Remove the hyphens from the beginning of str and return the new String.

Parameters

str:String: The string from which the hyphens should be removed.

Returns:String

the new String.

updateRequiredOptions	back to summary
private void updateRequiredOptions(Option option) Removes the option from the list of expected elements. Parameters option:Option the option

updateRequiredOptions

back to summary

private void updateRequiredOptions(Option option)

Removes the option from the list of expected elements.

Parameters

option:Option: the option

validate	back to summary
protected void validate() throws CLIException

visit	back to summary
private void visit(String token) throws CLIException

public Class DefaultParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail