Package picocli
Interface CommandLine.IParameterExceptionHandler
-
- Enclosing class:
- CommandLine
public static interface CommandLine.IParameterExceptionHandlerClasses implementing this interface know how to handleParameterExceptions(usually from invalid user input).Implementation Requirements:
Implementors that need to print messages to the console should use the output and error PrintWriters, and the color scheme from the CommandLine object obtained from the exception.
Implementation Note:
See
CommandLine.getParameterExceptionHandler()for a description of the default handler.API Note:
This interface supersedes
CommandLine.IExceptionHandler2.- Since:
- 4.0
- See Also:
CommandLine.setParameterExceptionHandler(IParameterExceptionHandler)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description inthandleParseException(CommandLine.ParameterException ex, java.lang.String[] args)Handles aParameterExceptionthat occurred while parsing the command line arguments and returns an exit code suitable for returning fromCommandLine.execute(String...).
-
-
-
Method Detail
-
handleParseException
int handleParseException(CommandLine.ParameterException ex, java.lang.String[] args) throws java.lang.Exception
Handles aParameterExceptionthat occurred while parsing the command line arguments and returns an exit code suitable for returning fromCommandLine.execute(String...).- Parameters:
ex- the ParameterException describing the problem that occurred while parsing the command line arguments, and the CommandLine representing the command or subcommand whose input was invalidargs- the command line arguments that could not be parsed- Returns:
- an exit code
- Throws:
java.lang.Exception
-
-