net.sourceforge.argparse4j.impl.type

Class CaseInsensitiveEnumArgumentType<T extends Enum<T>>

java.lang.Object

net.sourceforge.argparse4j.impl.type.CaseInsensitiveEnumArgumentType<T>

Type Parameters:

T - Type of enum

All Implemented Interfaces:

ArgumentType<T>, MetavarInference

public class CaseInsensitiveEnumArgumentType<T extends Enum<T>>
extends Object
implements ArgumentType<T>, MetavarInference

ArgumentType subclass for enum type with case-insensitive match.

If enum type is passed to Argument.type(Class), string comparison is performed in case-sensitive (this is default for all other type conversions). Usually in convention, enum name is all upper case letters, some times you want to do case-insensitive match for convenience. This class does that job.

Constructor Summary

Constructors

Constructor and Description
CaseInsensitiveEnumArgumentType(Class<T> type)

Method Summary

Modifier and Type	Method and Description
T	convert(ArgumentParser parser, Argument arg, String value) Converts value to appropriate type.
String[]	inferMetavar() Returns inferred array of metavar strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CaseInsensitiveEnumArgumentType

public CaseInsensitiveEnumArgumentType(Class<T> type)

Method Detail

convert

public T convert(ArgumentParser parser,
                 Argument arg,
                 String value)
          throws ArgumentParserException

Description copied from interface: ArgumentType

Converts value to appropriate type.

If the objects derived from RuntimeException are thrown in conversion because of invalid input from command line, subclass must catch these exceptions and wrap them in ArgumentParserException and give simple error message to explain what happened briefly.

Specified by:

convert in interface ArgumentType<T extends Enum<T>>

Parameters:

parser - The aprser.

arg - The argument this type attached to.

value - The attribute value.

Returns:

Converted object.

Throws:

ArgumentParserException - If conversion fails.

inferMetavar

public String[] inferMetavar()

Description copied from interface: MetavarInference

Returns inferred array of metavar strings.

The returned array is treated like when strings are given in Argument.metavar(String...).

Specified by:

inferMetavar in interface MetavarInference

Returns:

inferred array of metavar strings, or null if there is no metavar inferred.