Package picocli

Interface CommandLine.ITypeConverter<K>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      K convert​(java.lang.String value)
      Converts the specified command line argument value to some domain object.
    • Method Detail

      • convert

        K convert​(java.lang.String value)
           throws java.lang.Exception
        Converts the specified command line argument value to some domain object.
        Parameters:
        value - the command line argument String value
        Returns:
        the resulting domain object
        Throws:
        java.lang.Exception - an exception detailing what went wrong during the conversion. Any exception thrown from this method will be caught and shown to the end user. An example error message shown to the end user could look something like this: Invalid value for option '--some-option': cannot convert 'xxxinvalidinput' to SomeType (java.lang.IllegalArgumentException: Invalid format: must be 'x:y:z' but was 'xxxinvalidinput')
        CommandLine.TypeConversionException - throw this exception to have more control over the error message that is shown to the end user when type conversion fails. An example message shown to the user could look like this: Invalid value for option '--some-option': Invalid format: must be 'x:y:z' but was 'xxxinvalidinput'