de.esprit.common.clp

Class AbstractFileOption

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.common.clp.CommandLineOption<java.io.File>

de.esprit.common.clp.AbstractPathOption

de.esprit.common.clp.AbstractFileOption

All Implemented Interfaces:

Dumpable

Direct Known Subclasses:

DBToolCommandLineParser.MyOptionSqlScript, OptionOutFile

public class AbstractFileOption
extends AbstractPathOption

This option returns a File object

Author:

Rainer Buesch

Constructor Summary

Constructors

Constructor and Description
AbstractFileOption(java.lang.String option, java.lang.String argName, java.lang.String helpText)
AbstractFileOption(java.lang.String option, java.lang.String argName, java.lang.String helpText, boolean isMandatory)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkValue() Performs additional checks on the entered option value (i.e. file existence etc..)

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

getValue, isMustExist, parseValue, setMustExist

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

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

AbstractFileOption

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

AbstractFileOption

public AbstractFileOption(java.lang.String option,
                  java.lang.String argName,
                  java.lang.String helpText,
                  boolean isMandatory)

Method Detail

checkValue

public void checkValue()
                throws java.lang.Exception

Description copied from class: CommandLineOption

Performs additional checks on the entered option value (i.e. file existence etc..) If the option value is null but a defaultValue is defined then the latter is applied. The option may also check its dependencies of other options.

Overrides:

checkValue in class CommandLineOption<java.io.File>

Throws:

java.lang.Exception