Package eu.svjatoslav.commons.cli_helper.parameter_parser.parameter

Class StringOption

java.lang.Object

eu.svjatoslav.commons.cli_helper.parameter_parser.Option<String,StringOption>

eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption

public class StringOption
extends Option<String,StringOption>

This class represents commandline option which accepts exactly one parameter which is a string.

Field Summary

Fields

Modifier and Type	Field	Description
final String	defaultValue

Fields inherited from class eu.svjatoslav.commons.cli_helper.parameter_parser.Option

description, mandatory, parameters

Constructor Summary

Constructors

Constructor	Description
StringOption(String description)
StringOption(String description, String defaultValue)

Method Summary

Modifier and Type	Method	Description
String	describeFormat()
String	getValue()	Returns the value of the object.
boolean	isValid(String value)

Methods inherited from class eu.svjatoslav.commons.cli_helper.parameter_parser.Option

addAliases, addParameter, getAliasesAsString, getHelp, isMandatory, isPresent, matchesAlias, noMoreArguments, setMandatory, setPresent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

defaultValue

public final String defaultValue

Constructor Details

StringOption

public StringOption(String description)

StringOption

public StringOption(String description,
 String defaultValue)

Method Details

describeFormat

public String describeFormat()

Specified by:

describeFormat in class Option<String,StringOption>

Returns:

Single line parameter type description. For example: "file", "date", "integer", "regular expression", etc..

Note: for argument purpose description there is Option.description

getValue

public String getValue()

Description copied from class: Option

Returns the value of the object.

Specified by:

getValue in class Option<String,StringOption>

Returns:

the value of the object.

isValid

public boolean isValid(String value)

Specified by:

isValid in class Option<String,StringOption>

Parameters:

value - value to validate

Returns:

true if value is correct, false otherwise.