org.dishevelled.commandline.argument

Class StringArgument

java.lang.Object

org.dishevelled.commandline.argument.AbstractArgument<String>

org.dishevelled.commandline.argument.StringArgument

All Implemented Interfaces:

Argument<String>

public final class StringArgument
extends AbstractArgument<String>

A string argument.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
StringArgument(String shortName, String longName, String description, boolean required) Create a new string argument.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	convert(String s) Convert the specified string value into an instance of class E.

Methods inherited from class org.dishevelled.commandline.argument.AbstractArgument

equals, getDescription, getLongName, getShortName, getValue, getValue, hashCode, isArgumentString, isRequired, isValueString, visit, wasFound

Methods inherited from class java.lang.Object

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

Constructor Detail

StringArgument

public StringArgument(String shortName,
              String longName,
              String description,
              boolean required)

Create a new string argument.

Parameters:

shortName - short argument name

longName - long argument name

description - argument description

required - true if this argument is required

Method Detail

convert

protected String convert(String s)
                  throws Exception

Convert the specified string value into an instance of class E.

Specified by:

convert in class AbstractArgument<String>

Parameters:

s - string value

Returns:

an instance of class E converted from the specified string value

Throws:

Exception - if an error occurs