Package picocli

Class CommandLine.Model.ParserSpec

java.lang.Object

picocli.CommandLine.Model.ParserSpec

Enclosing class:

CommandLine.Model

public static class CommandLine.Model.ParserSpec
extends Object

Models parser configuration specification.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	abbreviatedOptionsAllowed
private boolean	abbreviatedSubcommandsAllowed
private boolean	allowOptionsAsOptionParameters
private boolean	allowSubcommandsAsOptionParameters
private boolean	aritySatisfiedByAttachedOptionParam
private Character	atFileCommentChar
private boolean	caseInsensitiveEnumValuesAllowed
private boolean	collectErrors
(package private) static final String	DEFAULT_END_OF_OPTIONS_DELIMITER
(package private) static final String	DEFAULT_SEPARATOR	Constant String holding the default separator between options and option parameters: "=".
private String	endOfOptionsDelimiter
private boolean	expandAtFiles
private boolean	limitSplit
private boolean	overwrittenOptionsAllowed
private boolean	posixClusteredShortOptionsAllowed
private String	separator
private boolean	splitQuotedStrings
private boolean	stopAtPositional
private boolean	stopAtUnmatched
private boolean	toggleBooleanFlags
private boolean	trimQuotes
private boolean	unmatchedArgumentsAllowed
private boolean	unmatchedOptionsAllowedAsOptionParameters
private boolean	unmatchedOptionsArePositionalParams
private boolean	useSimplifiedAtFiles

Constructor Summary

Constructors

Constructor	Description
ParserSpec()

Method Summary

Modifier and Type	Method	Description
boolean	abbreviatedOptionsAllowed()
CommandLine.Model.ParserSpec	abbreviatedOptionsAllowed(boolean abbreviatedOptionsAllowed)
boolean	abbreviatedSubcommandsAllowed()
CommandLine.Model.ParserSpec	abbreviatedSubcommandsAllowed(boolean abbreviatedSubcommandsAllowed)
boolean	allowOptionsAsOptionParameters()
CommandLine.Model.ParserSpec	allowOptionsAsOptionParameters(boolean allowOptionsAsOptionParameters)
boolean	allowSubcommandsAsOptionParameters()
CommandLine.Model.ParserSpec	allowSubcommandsAsOptionParameters(boolean allowSubcommandsAsOptionParameters)
boolean	aritySatisfiedByAttachedOptionParam()	Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.
CommandLine.Model.ParserSpec	aritySatisfiedByAttachedOptionParam(boolean newValue)	Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.
Character	atFileCommentChar()
CommandLine.Model.ParserSpec	atFileCommentChar(Character atFileCommentChar)
boolean	caseInsensitiveEnumValuesAllowed()
CommandLine.Model.ParserSpec	caseInsensitiveEnumValuesAllowed(boolean caseInsensitiveEnumValuesAllowed)
boolean	collectErrors()	Returns true if exceptions during parsing should be collected instead of thrown.
CommandLine.Model.ParserSpec	collectErrors(boolean collectErrors)	Sets whether exceptions during parsing should be collected instead of thrown.
String	endOfOptionsDelimiter()
CommandLine.Model.ParserSpec	endOfOptionsDelimiter(String delimiter)
boolean	expandAtFiles()
CommandLine.Model.ParserSpec	expandAtFiles(boolean expandAtFiles)
(package private) void	initFrom(CommandLine.Model.ParserSpec settings)
(package private) void	initSeparator(String value)
boolean	limitSplit()	Returns true if arguments should be split first before any further processing and the number of parts resulting from the split is limited to the max arity of the argument.
CommandLine.Model.ParserSpec	limitSplit(boolean limitSplit)	Sets whether arguments should be split first before any further processing.
boolean	overwrittenOptionsAllowed()
CommandLine.Model.ParserSpec	overwrittenOptionsAllowed(boolean overwrittenOptionsAllowed)
boolean	posixClusteredShortOptionsAllowed()
CommandLine.Model.ParserSpec	posixClusteredShortOptionsAllowed(boolean posixClusteredShortOptionsAllowed)
String	separator()	Returns the String to use as the separator between options and option parameters.
CommandLine.Model.ParserSpec	separator(String separator)	Sets the String to use as the separator between options and option parameters.
private boolean	shouldTrimQuotes()
private boolean	splitFirst()
boolean	splitQuotedStrings()
CommandLine.Model.ParserSpec	splitQuotedStrings(boolean splitQuotedStrings)
boolean	stopAtPositional()
CommandLine.Model.ParserSpec	stopAtPositional(boolean stopAtPositional)
boolean	stopAtUnmatched()
CommandLine.Model.ParserSpec	stopAtUnmatched(boolean stopAtUnmatched)
boolean	toggleBooleanFlags()
CommandLine.Model.ParserSpec	toggleBooleanFlags(boolean toggleBooleanFlags)
String	toString()
boolean	trimQuotes()
CommandLine.Model.ParserSpec	trimQuotes(boolean trimQuotes)
boolean	unmatchedArgumentsAllowed()
CommandLine.Model.ParserSpec	unmatchedArgumentsAllowed(boolean unmatchedArgumentsAllowed)
boolean	unmatchedOptionsAllowedAsOptionParameters()
CommandLine.Model.ParserSpec	unmatchedOptionsAllowedAsOptionParameters(boolean unmatchedOptionsAllowedAsOptionParameters)
boolean	unmatchedOptionsArePositionalParams()
CommandLine.Model.ParserSpec	unmatchedOptionsArePositionalParams(boolean unmatchedOptionsArePositionalParams)
(package private) void	updateSeparator(String value)
boolean	useSimplifiedAtFiles()
CommandLine.Model.ParserSpec	useSimplifiedAtFiles(boolean useSimplifiedAtFiles)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SEPARATOR

static final String DEFAULT_SEPARATOR

Constant String holding the default separator between options and option parameters: "=".

See Also:

• Constant Field Values

DEFAULT_END_OF_OPTIONS_DELIMITER

static final String DEFAULT_END_OF_OPTIONS_DELIMITER

See Also:

• Constant Field Values

abbreviatedOptionsAllowed

private boolean abbreviatedOptionsAllowed

abbreviatedSubcommandsAllowed

private boolean abbreviatedSubcommandsAllowed

allowOptionsAsOptionParameters

private boolean allowOptionsAsOptionParameters

allowSubcommandsAsOptionParameters

private boolean allowSubcommandsAsOptionParameters

aritySatisfiedByAttachedOptionParam

private boolean aritySatisfiedByAttachedOptionParam

atFileCommentChar

private Character atFileCommentChar

caseInsensitiveEnumValuesAllowed

private boolean caseInsensitiveEnumValuesAllowed

collectErrors

private boolean collectErrors

endOfOptionsDelimiter

private String endOfOptionsDelimiter

expandAtFiles

private boolean expandAtFiles

limitSplit

private boolean limitSplit

overwrittenOptionsAllowed

private boolean overwrittenOptionsAllowed

posixClusteredShortOptionsAllowed

private boolean posixClusteredShortOptionsAllowed

separator

private String separator

splitQuotedStrings

private boolean splitQuotedStrings

stopAtPositional

private boolean stopAtPositional

stopAtUnmatched

private boolean stopAtUnmatched

toggleBooleanFlags

private boolean toggleBooleanFlags

trimQuotes

private boolean trimQuotes

unmatchedArgumentsAllowed

private boolean unmatchedArgumentsAllowed

unmatchedOptionsAllowedAsOptionParameters

private boolean unmatchedOptionsAllowedAsOptionParameters

unmatchedOptionsArePositionalParams

private boolean unmatchedOptionsArePositionalParams

useSimplifiedAtFiles

private boolean useSimplifiedAtFiles

Constructor Details

ParserSpec

public ParserSpec()

Method Details

separator

public String separator()

Returns the String to use as the separator between options and option parameters. "=" by default, initialized from CommandLine.Command.separator() if defined.

stopAtUnmatched

public boolean stopAtUnmatched()

See Also:

• CommandLine.isStopAtUnmatched()

stopAtPositional

public boolean stopAtPositional()

See Also:

• CommandLine.isStopAtPositional()

endOfOptionsDelimiter

public String endOfOptionsDelimiter()

Since:

3.5

See Also:

• CommandLine.getEndOfOptionsDelimiter()

toggleBooleanFlags

public boolean toggleBooleanFlags()

See Also:

• CommandLine.isToggleBooleanFlags()

overwrittenOptionsAllowed

public boolean overwrittenOptionsAllowed()

See Also:

• CommandLine.isOverwrittenOptionsAllowed()

unmatchedArgumentsAllowed

public boolean unmatchedArgumentsAllowed()

See Also:

• CommandLine.isUnmatchedArgumentsAllowed()

abbreviatedSubcommandsAllowed

public boolean abbreviatedSubcommandsAllowed()

See Also:

• CommandLine.isAbbreviatedSubcommandsAllowed()

abbreviatedOptionsAllowed

public boolean abbreviatedOptionsAllowed()

See Also:

• CommandLine.isAbbreviatedOptionsAllowed()

expandAtFiles

public boolean expandAtFiles()

See Also:

• CommandLine.isExpandAtFiles()

atFileCommentChar

public Character atFileCommentChar()

Since:

3.5

See Also:

• CommandLine.getAtFileCommentChar()

useSimplifiedAtFiles

public boolean useSimplifiedAtFiles()

Since:

3.9

See Also:

• CommandLine.isUseSimplifiedAtFiles()

posixClusteredShortOptionsAllowed

public boolean posixClusteredShortOptionsAllowed()

See Also:

• CommandLine.isPosixClusteredShortOptionsAllowed()

caseInsensitiveEnumValuesAllowed

public boolean caseInsensitiveEnumValuesAllowed()

Since:

3.4

See Also:

• CommandLine.isCaseInsensitiveEnumValuesAllowed()

trimQuotes

public boolean trimQuotes()

Since:

3.7

See Also:

• CommandLine.isTrimQuotes()

splitQuotedStrings

public boolean splitQuotedStrings()

Since:

3.7

See Also:

• CommandLine.isSplitQuotedStrings()

unmatchedOptionsArePositionalParams

public boolean unmatchedOptionsArePositionalParams()

See Also:

• CommandLine.isUnmatchedOptionsArePositionalParams()

unmatchedOptionsAllowedAsOptionParameters

public boolean unmatchedOptionsAllowedAsOptionParameters()

Since:

4.4

See Also:

• CommandLine.isUnmatchedOptionsAllowedAsOptionParameters()

allowSubcommandsAsOptionParameters

public boolean allowSubcommandsAsOptionParameters()

Since:

4.7.6

See Also:

• CommandLine.isAllowSubcommandsAsOptionParameters()

allowOptionsAsOptionParameters

public boolean allowOptionsAsOptionParameters()

Since:

4.7.6

See Also:

• CommandLine.isAllowOptionsAsOptionParameters()

splitFirst

private boolean splitFirst()

limitSplit

public boolean limitSplit()

Returns true if arguments should be split first before any further processing and the number of parts resulting from the split is limited to the max arity of the argument.

aritySatisfiedByAttachedOptionParam

public boolean aritySatisfiedByAttachedOptionParam()

Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity. The default is false.

collectErrors

public boolean collectErrors()

Returns true if exceptions during parsing should be collected instead of thrown. Multiple errors may be encountered during parsing. These can be obtained from CommandLine.ParseResult.errors().

Since:

3.2

separator

public CommandLine.Model.ParserSpec separator(String separator)

Sets the String to use as the separator between options and option parameters.

Returns:

this ParserSpec for method chaining

stopAtUnmatched

public CommandLine.Model.ParserSpec stopAtUnmatched(boolean stopAtUnmatched)

See Also:

• CommandLine.setStopAtUnmatched(boolean)

stopAtPositional

public CommandLine.Model.ParserSpec stopAtPositional(boolean stopAtPositional)

See Also:

• CommandLine.setStopAtPositional(boolean)

endOfOptionsDelimiter

public CommandLine.Model.ParserSpec endOfOptionsDelimiter(String delimiter)

Since:

3.5

See Also:

• CommandLine.setEndOfOptionsDelimiter(String)

toggleBooleanFlags

public CommandLine.Model.ParserSpec toggleBooleanFlags(boolean toggleBooleanFlags)

See Also:

• CommandLine.setToggleBooleanFlags(boolean)

overwrittenOptionsAllowed

public CommandLine.Model.ParserSpec overwrittenOptionsAllowed(boolean overwrittenOptionsAllowed)

See Also:

• CommandLine.setOverwrittenOptionsAllowed(boolean)

unmatchedArgumentsAllowed

public CommandLine.Model.ParserSpec unmatchedArgumentsAllowed(boolean unmatchedArgumentsAllowed)

See Also:

• CommandLine.setUnmatchedArgumentsAllowed(boolean)

abbreviatedSubcommandsAllowed

public CommandLine.Model.ParserSpec abbreviatedSubcommandsAllowed(boolean abbreviatedSubcommandsAllowed)

See Also:

• CommandLine.setAbbreviatedSubcommandsAllowed(boolean)

abbreviatedOptionsAllowed

public CommandLine.Model.ParserSpec abbreviatedOptionsAllowed(boolean abbreviatedOptionsAllowed)

See Also:

• CommandLine.setAbbreviatedOptionsAllowed(boolean)

expandAtFiles

public CommandLine.Model.ParserSpec expandAtFiles(boolean expandAtFiles)

See Also:

• CommandLine.setExpandAtFiles(boolean)

atFileCommentChar

public CommandLine.Model.ParserSpec atFileCommentChar(Character atFileCommentChar)

Since:

3.5

See Also:

• CommandLine.setAtFileCommentChar(Character)

useSimplifiedAtFiles

public CommandLine.Model.ParserSpec useSimplifiedAtFiles(boolean useSimplifiedAtFiles)

Since:

3.9

See Also:

• CommandLine.setUseSimplifiedAtFiles(boolean)

posixClusteredShortOptionsAllowed

public CommandLine.Model.ParserSpec posixClusteredShortOptionsAllowed(boolean posixClusteredShortOptionsAllowed)

See Also:

• CommandLine.setPosixClusteredShortOptionsAllowed(boolean)

caseInsensitiveEnumValuesAllowed

public CommandLine.Model.ParserSpec caseInsensitiveEnumValuesAllowed(boolean caseInsensitiveEnumValuesAllowed)

Since:

3.4

See Also:

• CommandLine.setCaseInsensitiveEnumValuesAllowed(boolean)

trimQuotes

public CommandLine.Model.ParserSpec trimQuotes(boolean trimQuotes)

Since:

3.7

See Also:

• CommandLine.setTrimQuotes(boolean)

splitQuotedStrings

public CommandLine.Model.ParserSpec splitQuotedStrings(boolean splitQuotedStrings)

Since:

3.7

See Also:

• CommandLine.setSplitQuotedStrings(boolean)

unmatchedOptionsAllowedAsOptionParameters

public CommandLine.Model.ParserSpec unmatchedOptionsAllowedAsOptionParameters(boolean unmatchedOptionsAllowedAsOptionParameters)

Since:

4.4

See Also:

• CommandLine.setUnmatchedOptionsAllowedAsOptionParameters(boolean)

unmatchedOptionsArePositionalParams

public CommandLine.Model.ParserSpec unmatchedOptionsArePositionalParams(boolean unmatchedOptionsArePositionalParams)

See Also:

• CommandLine.setUnmatchedOptionsArePositionalParams(boolean)

allowSubcommandsAsOptionParameters

public CommandLine.Model.ParserSpec allowSubcommandsAsOptionParameters(boolean allowSubcommandsAsOptionParameters)

Since:

4.7.6

See Also:

• CommandLine.setAllowSubcommandsAsOptionParameters(boolean)

allowOptionsAsOptionParameters

public CommandLine.Model.ParserSpec allowOptionsAsOptionParameters(boolean allowOptionsAsOptionParameters)

Since:

4.7.6

See Also:

• CommandLine.setAllowOptionsAsOptionParameters(boolean)

collectErrors

public CommandLine.Model.ParserSpec collectErrors(boolean collectErrors)

Sets whether exceptions during parsing should be collected instead of thrown. Multiple errors may be encountered during parsing. These can be obtained from CommandLine.ParseResult.errors().

Since:

3.2

aritySatisfiedByAttachedOptionParam

public CommandLine.Model.ParserSpec aritySatisfiedByAttachedOptionParam(boolean newValue)

Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity. The default is false.

limitSplit

public CommandLine.Model.ParserSpec limitSplit(boolean limitSplit)

Sets whether arguments should be split first before any further processing. If true, the original argument will only be split into as many parts as allowed by max arity.

shouldTrimQuotes

private boolean shouldTrimQuotes()

initSeparator

void initSeparator(String value)

updateSeparator

void updateSeparator(String value)

toString

public String toString()

Overrides:

toString in class Object

initFrom

void initFrom(CommandLine.Model.ParserSpec settings)