snaq.util.jclap

Class FileOption

java.lang.Object

snaq.util.jclap.Option<String>

snaq.util.jclap.StringOption

snaq.util.jclap.FileOption

public class FileOption
extends StringOption

Author:

Giles Winstanley

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileOption.FileFilter Implementation of an StringOption.Filter which filters based on existence and type of file to which the string refers.

Nested classes/interfaces inherited from class snaq.util.jclap.StringOption

StringOption.Filter

Field Summary

Fields inherited from class snaq.util.jclap.Option

bundle, ILLEGAL_SN_CHARS, locale, MAX_COUNT_LIMIT, MIN_COUNT_LIMIT, values

Constructor Summary

Constructors

Constructor and Description
FileOption(String shortName, String longName, String description, boolean mandatory, boolean allowMany)
FileOption(String shortName, String longName, String description, int minCount, int maxCount)

Method Summary

Modifier and Type	Method and Description
protected String	getUsageTypeString() Returns the option type, for display in the usage message.

Methods inherited from class snaq.util.jclap.StringOption

getFilter, getType, parseValue, setFilter

Methods inherited from class snaq.util.jclap.Option

addValue, equals, getDescription, getLongName, getMaxCount, getMinCount, getShortName, getValues, hashCode, isAllowMany, isHidden, isMandatory, requiresValue, setHidden, setMinMaxCounts, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileOption

public FileOption(String shortName,
                  String longName,
                  String description,
                  int minCount,
                  int maxCount)

FileOption

public FileOption(String shortName,
                  String longName,
                  String description,
                  boolean mandatory,
                  boolean allowMany)

Method Detail

getUsageTypeString

protected String getUsageTypeString()

Description copied from class: Option

Returns the option type, for display in the usage message. This may be overridden by sub-classes to provide a more meaningful type. By default this returns an appropriate type for the primitives, and string type for all others.

Overrides:

getUsageTypeString in class Option<String>

Returns:

string describing type