de.esprit.common.clp

Class AbstractStringOption

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.common.clp.CommandLineOption<java.lang.String>

de.esprit.common.clp.AbstractStringOption

All Implemented Interfaces:

Dumpable

Direct Known Subclasses:

AbstractUnlCLP.OptionDboPkg, AbstractUnlCLP.OptionTable, AppCacheRootDirOption, ClientCommandLineParser.OptionNetIo, ClientCommandLineParser.OptionPassword, ClientCommandLineParser.OptionUser, DatabaseCommandLineParser.OptionDbPassword, DatabaseCommandLineParser.OptionDbUrl, DatabaseCommandLineParser.OptionDbUser, DatabaseCommandLineParser.OptionJdbcDriver, DatabaseCommandLineParser.OptionSchema, DBToolCommandLineParser.MyOptionSqlCommand

public class AbstractStringOption
extends CommandLineOption<java.lang.String>

This it the base class for all String options

Author:

Rainer Buesch

Constructor Summary

Constructors

Constructor and Description
AbstractStringOption(java.lang.String option, java.lang.String argName, java.lang.String helpText)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getValue() Returns the parsed value of this option.
protected void	parseValue(java.lang.String value) Parses and stores the given value from the command-line to this option.

Methods inherited from class de.esprit.common.clp.CommandLineOption

checkValue, equals, getArgumentName, getDefaultValue, getEnvVariableName, getEnvVariableValue, getHelpText, getOption, getOptionAndArgument, getStringValue, hasArgument, hashCode, isMandatory, isPrintHelp, isPrintSyntax, isSecret, isValueTakenFromEnvVariable, parseDefaultValue, parseValue, setDefaultValue, setEnvVariableName, setFound, setHelpText, setMandatory, setPrintHelp, setPrintSyntax, setSecret, setStringValue, toDumpString, toString, wasFound

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStringOption

public AbstractStringOption(java.lang.String option,
                    java.lang.String argName,
                    java.lang.String helpText)

Method Detail

getValue

public final java.lang.String getValue()

Description copied from class: CommandLineOption

Returns the parsed value of this option.

Specified by:

getValue in class CommandLineOption<java.lang.String>

parseValue

protected void parseValue(java.lang.String value)
                   throws java.lang.Exception

Description copied from class: CommandLineOption

Parses and stores the given value from the command-line to this option. Subclasses perform any type conversion if necessary.

Specified by:

parseValue in class CommandLineOption<java.lang.String>

Throws:

java.lang.Exception