de.esprit.common.clp

Class AbstractPathOption

java.lang.Object

de.esprit.common.util.DumpableObject

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

de.esprit.common.clp.AbstractPathOption

All Implemented Interfaces:

Dumpable

Direct Known Subclasses:

AbstractDirectoryOption, AbstractFileOption

public abstract class AbstractPathOption
extends CommandLineOption<java.io.File>

This abstract class encapsulates the common behavior of path based subclasses.

Author:

Rainer Buesch

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getValue() Returns the parsed value of this option.
boolean	isMustExist()
protected void	parseValue(java.lang.String value) Parses and stores the given value from the command-line to this option.
void	setMustExist(boolean isMustExist) Tells whether the given path must exist in the filesystem

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

AbstractPathOption

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

Method Detail

getValue

public final java.io.File getValue()

Description copied from class: CommandLineOption

Returns the parsed value of this option.

Specified by:

getValue in class CommandLineOption<java.io.File>

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.io.File>

Throws:

java.lang.Exception

isMustExist

public final boolean isMustExist()

setMustExist

public final void setMustExist(boolean isMustExist)

Tells whether the given path must exist in the filesystem