net.sourceforge.argparse4j.impl.type

Class StringArgumentType

java.lang.Object

net.sourceforge.argparse4j.impl.type.StringArgumentType

All Implemented Interfaces:

ArgumentType<String>

public class StringArgumentType
extends Object
implements ArgumentType<String>

Specialized to String type, just echos back given string.

Constructor Summary

Constructors

Constructor and Description
StringArgumentType()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StringArgumentType

public StringArgumentType()

Method Detail

convert

public String 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<String>

Parameters:

parser - The parser.

arg - The argument this type attached to.

value - The attribute value.

Returns:

Converted object.

Throws:

ArgumentParserException - If conversion fails.