Module net.sourceforge.argparse4j

Package net.sourceforge.argparse4j.impl.type

Class EnumArgumentType<T extends Enum<T>>

java.lang.Object

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

Type Parameters:

T - Type of enum

All Implemented Interfaces:

ArgumentType<T>

@Deprecated
public class EnumArgumentType<T extends Enum<T>>
extends Object
implements ArgumentType<T>

Deprecated.

Use ReflectArgumentType instead.

ArgumentType subclass for enum type.

Since enum does not have a constructor with string argument, it cannot be used with Argument.type(Class). Instead use this class to specify enum type. The enums in its nature have limited number of members. In convert(ArgumentParser, Argument, String), String value will be converted to one of them. If it cannot be converted, convert(ArgumentParser, Argument, String) will throw ArgumentParserException. This means it already act like a Argument.choices(Object...).

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<T>	type_	Deprecated.

Constructor Summary

Constructors

Constructor	Description
EnumArgumentType(Class<T> type)	Deprecated.

Method Summary

Modifier and Type	Method	Description
T	convert(ArgumentParser parser, Argument arg, String value)	Deprecated. Converts value to appropriate type.

Methods inherited from class java.lang.Object

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

Field Details

type_

private final Class<T extends Enum<T>> type_

Deprecated.

Constructor Details

EnumArgumentType

public EnumArgumentType(Class<T> type)

Deprecated.

Method Details

convert

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

Deprecated.

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 parser.

arg - The argument this type attached to.

value - The attribute value.

Returns:

Converted object.

Throws:

ArgumentParserException - If conversion fails.