Package picocli
Class CommandLine.UnmatchedArgumentException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- picocli.CommandLine.PicocliException
-
- picocli.CommandLine.ParameterException
-
- picocli.CommandLine.UnmatchedArgumentException
-
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- CommandLine
public static class CommandLine.UnmatchedArgumentException extends CommandLine.ParameterException
Exception indicating that a command line argument could not be mapped to any of the fields annotated withCommandLine.OptionorCommandLine.Parameters.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class picocli.CommandLine.ParameterException
commandLine
-
-
Constructor Summary
Constructors Constructor Description UnmatchedArgumentException(CommandLine commandLine, java.lang.String msg)UnmatchedArgumentException(CommandLine commandLine, java.util.List<java.lang.String> args)UnmatchedArgumentException(CommandLine commandLine, java.util.List<java.lang.String> args, java.lang.String extraMsg)UnmatchedArgumentException(CommandLine commandLine, java.util.Stack<java.lang.String> args)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>getSuggestions()Returns suggested solutions if such solutions exist, otherwise returns an empty list.java.util.List<java.lang.String>getUnmatched()Returns the unmatched command line arguments.booleanisUnknownOption()Returnstrueif the first unmatched command line arguments resembles an option,falseotherwise.booleanprintSuggestions(java.io.PrintStream out)Returnstrueand prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse.booleanprintSuggestions(java.io.PrintWriter writer)Returnstrueand prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse.static booleanprintSuggestions(CommandLine.ParameterException ex, java.io.PrintStream out)Returnstrueand prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse.static booleanprintSuggestions(CommandLine.ParameterException ex, java.io.PrintWriter writer)Returnstrueand prints suggested solutions to the specified writer if such solutions exist, otherwise returnsfalse.-
Methods inherited from class picocli.CommandLine.ParameterException
getArgSpec, getCommandLine, getValue
-
-
-
-
Constructor Detail
-
UnmatchedArgumentException
public UnmatchedArgumentException(CommandLine commandLine, java.lang.String msg)
-
UnmatchedArgumentException
public UnmatchedArgumentException(CommandLine commandLine, java.util.Stack<java.lang.String> args)
-
UnmatchedArgumentException
public UnmatchedArgumentException(CommandLine commandLine, java.util.List<java.lang.String> args)
-
UnmatchedArgumentException
public UnmatchedArgumentException(CommandLine commandLine, java.util.List<java.lang.String> args, java.lang.String extraMsg)
-
-
Method Detail
-
printSuggestions
public static boolean printSuggestions(CommandLine.ParameterException ex, java.io.PrintStream out)
Returnstrueand prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse.- Since:
- 3.3.0
-
printSuggestions
public static boolean printSuggestions(CommandLine.ParameterException ex, java.io.PrintWriter writer)
Returnstrueand prints suggested solutions to the specified writer if such solutions exist, otherwise returnsfalse.- Since:
- 4.0
-
getUnmatched
public java.util.List<java.lang.String> getUnmatched()
Returns the unmatched command line arguments.- Since:
- 3.3.0
-
isUnknownOption
public boolean isUnknownOption()
Returnstrueif the first unmatched command line arguments resembles an option,falseotherwise.- Since:
- 3.3.0
-
printSuggestions
public boolean printSuggestions(java.io.PrintStream out)
Returnstrueand prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse.- Since:
- 3.3.0
-
printSuggestions
public boolean printSuggestions(java.io.PrintWriter writer)
Returnstrueand prints suggested solutions to the specified stream if such solutions exist, otherwise returnsfalse.- Since:
- 4.0
-
getSuggestions
public java.util.List<java.lang.String> getSuggestions()
Returns suggested solutions if such solutions exist, otherwise returns an empty list.- Since:
- 3.3.0
-
-