Module info.picocli
Package picocli

Class CommandLine.ParameterException

    • Field Detail

    • Constructor Detail

      • ParameterException

        public ParameterException​(CommandLine commandLine,
                                  String msg)
        Constructs a new ParameterException with the specified CommandLine and error message.
        Parameters:
        commandLine - the command or subcommand whose input was invalid
        msg - describes the problem
        Since:
        2.0
      • ParameterException

        public ParameterException​(CommandLine commandLine,
                                  String msg,
                                  Throwable t)
        Constructs a new ParameterException with the specified CommandLine and error message.
        Parameters:
        commandLine - the command or subcommand whose input was invalid
        msg - describes the problem
        t - the throwable that caused this ParameterException
        Since:
        2.0
      • ParameterException

        public ParameterException​(CommandLine commandLine,
                                  String msg,
                                  Throwable t,
                                  CommandLine.Model.ArgSpec argSpec,
                                  String value)
        Constructs a new ParameterException with the specified CommandLine and error message.
        Parameters:
        commandLine - the command or subcommand whose input was invalid
        msg - describes the problem
        t - the throwable that caused this ParameterException
        argSpec - the argSpec that caused this ParameterException
        value - the value that caused this ParameterException
        Since:
        3.2
      • ParameterException

        public ParameterException​(CommandLine commandLine,
                                  String msg,
                                  CommandLine.Model.ArgSpec argSpec,
                                  String value)
        Constructs a new ParameterException with the specified CommandLine and error message.
        Parameters:
        commandLine - the command or subcommand whose input was invalid
        msg - describes the problem
        argSpec - the argSpec that caused this ParameterException
        value - the value that caused this ParameterException
        Since:
        3.2
    • Method Detail

      • getCommandLine

        public CommandLine getCommandLine()
        Returns the CommandLine object for the (sub)command whose input could not be parsed.
        Returns:
        the CommandLine object for the (sub)command where parsing failed.
        Since:
        2.0
      • getArgSpec

        public CommandLine.Model.ArgSpec getArgSpec()
        Returns the ArgSpec object for the (sub)command whose input could not be parsed.
        Returns:
        the ArgSpec object for the (sub)command where parsing failed.
        Since:
        3.2
      • getValue

        public String getValue()
        Returns the String value for the (sub)command whose input could not be parsed.
        Returns:
        the String value for the (sub)command where parsing failed.
        Since:
        3.2