de.esprit.common.clp

Class AbstractDirectoryOption

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

All Implemented Interfaces:

Dumpable

Direct Known Subclasses:

DatabaseCommandLineParser.OptionCredDir, DatabaseCommandLineParser.OptionCredFile, OptionLogDir, OptionServerWorkspaceDir, OptionWorkspaceDir

public class AbstractDirectoryOption
extends AbstractPathOption

This option defines a target directory.

Author:

Rainer Buesch

Constructor Summary

Constructors

Constructor and Description
AbstractDirectoryOption(java.lang.String option, java.lang.String argName, java.lang.String helpText)
AbstractDirectoryOption(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..)
boolean	isDoCreate()
void	setDoCreate(boolean isDoCreate) If this flag indicates, that the directory should be auto-created if missing.

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

AbstractDirectoryOption

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

AbstractDirectoryOption

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

Method Detail

isDoCreate

public final boolean isDoCreate()

setDoCreate

public final void setDoCreate(boolean isDoCreate)

If this flag indicates, that the directory should be auto-created if missing.

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