Module info.picocli
Package picocli

Class CommandLine.UseDefaultConverter

  • All Implemented Interfaces:
    Enclosing class:

    public static final class CommandLine.UseDefaultConverter
    extends Object
    implements CommandLine.ITypeConverter<Object>
    Converter that can be used to signal to picocli that it should use the default converter. This can be useful with maps:
       class App {
           @Option(names = "-D", converter = {UseDefaultConverter.class, GenericValueConverter.class})
           Map<String, GenericValue<?>> values;
    The convert(String) method of this class always throws an UnsupportedOperationException.
    • Constructor Detail

      • UseDefaultConverter

        public UseDefaultConverter()
    • Method Detail

      • convert

        public Object convert​(String value)
                       throws Exception
        Always throws UnsupportedOperationException.
        Specified by:
        convert in interface CommandLine.ITypeConverter<Object>
        value - the command line argument String value
        the resulting domain object
        UnsupportedOperationException - always
        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'