Package picocli
Class CommandLine.Model.ParserSpec
- java.lang.Object
-
- picocli.CommandLine.Model.ParserSpec
-
- Enclosing class:
- CommandLine.Model
public static class CommandLine.Model.ParserSpec extends java.lang.ObjectModels parser configuration specification.- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description ParserSpec()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanabbreviatedOptionsAllowed()CommandLine.Model.ParserSpecabbreviatedOptionsAllowed(boolean abbreviatedOptionsAllowed)booleanabbreviatedSubcommandsAllowed()CommandLine.Model.ParserSpecabbreviatedSubcommandsAllowed(boolean abbreviatedSubcommandsAllowed)booleanallowOptionsAsOptionParameters()CommandLine.Model.ParserSpecallowOptionsAsOptionParameters(boolean allowOptionsAsOptionParameters)booleanallowSubcommandsAsOptionParameters()CommandLine.Model.ParserSpecallowSubcommandsAsOptionParameters(boolean allowSubcommandsAsOptionParameters)booleanaritySatisfiedByAttachedOptionParam()Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.CommandLine.Model.ParserSpecaritySatisfiedByAttachedOptionParam(boolean newValue)Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.java.lang.CharacteratFileCommentChar()CommandLine.Model.ParserSpecatFileCommentChar(java.lang.Character atFileCommentChar)booleancaseInsensitiveEnumValuesAllowed()CommandLine.Model.ParserSpeccaseInsensitiveEnumValuesAllowed(boolean caseInsensitiveEnumValuesAllowed)booleancollectErrors()Returns true if exceptions during parsing should be collected instead of thrown.CommandLine.Model.ParserSpeccollectErrors(boolean collectErrors)Sets whether exceptions during parsing should be collected instead of thrown.java.lang.StringendOfOptionsDelimiter()CommandLine.Model.ParserSpecendOfOptionsDelimiter(java.lang.String delimiter)booleanexpandAtFiles()CommandLine.Model.ParserSpecexpandAtFiles(boolean expandAtFiles)booleanlimitSplit()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.ParserSpeclimitSplit(boolean limitSplit)Sets whether arguments should be split first before any further processing.booleanoverwrittenOptionsAllowed()CommandLine.Model.ParserSpecoverwrittenOptionsAllowed(boolean overwrittenOptionsAllowed)booleanposixClusteredShortOptionsAllowed()CommandLine.Model.ParserSpecposixClusteredShortOptionsAllowed(boolean posixClusteredShortOptionsAllowed)java.lang.Stringseparator()Returns the String to use as the separator between options and option parameters.CommandLine.Model.ParserSpecseparator(java.lang.String separator)Sets the String to use as the separator between options and option parameters.booleansplitQuotedStrings()CommandLine.Model.ParserSpecsplitQuotedStrings(boolean splitQuotedStrings)booleanstopAtPositional()CommandLine.Model.ParserSpecstopAtPositional(boolean stopAtPositional)booleanstopAtUnmatched()CommandLine.Model.ParserSpecstopAtUnmatched(boolean stopAtUnmatched)booleantoggleBooleanFlags()CommandLine.Model.ParserSpectoggleBooleanFlags(boolean toggleBooleanFlags)java.lang.StringtoString()booleantrimQuotes()CommandLine.Model.ParserSpectrimQuotes(boolean trimQuotes)booleanunmatchedArgumentsAllowed()CommandLine.Model.ParserSpecunmatchedArgumentsAllowed(boolean unmatchedArgumentsAllowed)booleanunmatchedOptionsAllowedAsOptionParameters()CommandLine.Model.ParserSpecunmatchedOptionsAllowedAsOptionParameters(boolean unmatchedOptionsAllowedAsOptionParameters)booleanunmatchedOptionsArePositionalParams()CommandLine.Model.ParserSpecunmatchedOptionsArePositionalParams(boolean unmatchedOptionsArePositionalParams)booleanuseSimplifiedAtFiles()CommandLine.Model.ParserSpecuseSimplifiedAtFiles(boolean useSimplifiedAtFiles)
-
-
-
Method Detail
-
separator
public java.lang.String separator()
Returns the String to use as the separator between options and option parameters."="by default, initialized fromCommandLine.Command.separator()if defined.
-
stopAtUnmatched
public boolean stopAtUnmatched()
- See Also:
CommandLine.isStopAtUnmatched()
-
stopAtPositional
public boolean stopAtPositional()
- See Also:
CommandLine.isStopAtPositional()
-
endOfOptionsDelimiter
public java.lang.String endOfOptionsDelimiter()
- Since:
- 3.5
- See Also:
CommandLine.getEndOfOptionsDelimiter()
-
toggleBooleanFlags
public boolean toggleBooleanFlags()
- See Also:
CommandLine.isToggleBooleanFlags()
-
overwrittenOptionsAllowed
public boolean overwrittenOptionsAllowed()
-
unmatchedArgumentsAllowed
public boolean unmatchedArgumentsAllowed()
-
abbreviatedSubcommandsAllowed
public boolean abbreviatedSubcommandsAllowed()
-
abbreviatedOptionsAllowed
public boolean abbreviatedOptionsAllowed()
-
expandAtFiles
public boolean expandAtFiles()
- See Also:
CommandLine.isExpandAtFiles()
-
atFileCommentChar
public java.lang.Character atFileCommentChar()
- Since:
- 3.5
- See Also:
CommandLine.getAtFileCommentChar()
-
useSimplifiedAtFiles
public boolean useSimplifiedAtFiles()
- Since:
- 3.9
- See Also:
CommandLine.isUseSimplifiedAtFiles()
-
posixClusteredShortOptionsAllowed
public boolean posixClusteredShortOptionsAllowed()
-
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()
-
unmatchedOptionsAllowedAsOptionParameters
public boolean unmatchedOptionsAllowedAsOptionParameters()
- Since:
- 4.4
- See Also:
CommandLine.isUnmatchedOptionsAllowedAsOptionParameters()
-
allowSubcommandsAsOptionParameters
public boolean allowSubcommandsAsOptionParameters()
- Since:
- 4.7.7-SNAPSHOT
- See Also:
CommandLine.isAllowSubcommandsAsOptionParameters()
-
allowOptionsAsOptionParameters
public boolean allowOptionsAsOptionParameters()
- Since:
- 4.7.7-SNAPSHOT
- See Also:
CommandLine.isAllowOptionsAsOptionParameters()
-
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 isfalse.
-
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 fromCommandLine.ParseResult.errors().- Since:
- 3.2
-
separator
public CommandLine.Model.ParserSpec separator(java.lang.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(java.lang.String delimiter)
- Since:
- 3.5
- See Also:
CommandLine.setEndOfOptionsDelimiter(String)
-
toggleBooleanFlags
public CommandLine.Model.ParserSpec toggleBooleanFlags(boolean toggleBooleanFlags)
-
overwrittenOptionsAllowed
public CommandLine.Model.ParserSpec overwrittenOptionsAllowed(boolean overwrittenOptionsAllowed)
-
unmatchedArgumentsAllowed
public CommandLine.Model.ParserSpec unmatchedArgumentsAllowed(boolean unmatchedArgumentsAllowed)
-
abbreviatedSubcommandsAllowed
public CommandLine.Model.ParserSpec abbreviatedSubcommandsAllowed(boolean abbreviatedSubcommandsAllowed)
-
abbreviatedOptionsAllowed
public CommandLine.Model.ParserSpec abbreviatedOptionsAllowed(boolean abbreviatedOptionsAllowed)
-
expandAtFiles
public CommandLine.Model.ParserSpec expandAtFiles(boolean expandAtFiles)
- See Also:
CommandLine.setExpandAtFiles(boolean)
-
atFileCommentChar
public CommandLine.Model.ParserSpec atFileCommentChar(java.lang.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)
-
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)
-
allowSubcommandsAsOptionParameters
public CommandLine.Model.ParserSpec allowSubcommandsAsOptionParameters(boolean allowSubcommandsAsOptionParameters)
- Since:
- 4.7.7-SNAPSHOT
- See Also:
CommandLine.setAllowSubcommandsAsOptionParameters(boolean)
-
allowOptionsAsOptionParameters
public CommandLine.Model.ParserSpec allowOptionsAsOptionParameters(boolean allowOptionsAsOptionParameters)
- Since:
- 4.7.7-SNAPSHOT
- 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 fromCommandLine.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 isfalse.
-
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.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-