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

Class DirectoryOptions

java.lang.Object

eu.svjatoslav.commons.cli_helper.parameter_parser.Option<List<File>,DirectoryOptions>

eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions

public class DirectoryOptions
extends Option<List<File>,DirectoryOptions>

DirectoryOptions class represents a command-line option for one or more directories.

Field Summary

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

description, mandatory, parameters

Constructor Summary

Constructors

Constructor	Description
DirectoryOptions(String description)	Creates a new DirectoryOptions object with the given description.

Method Summary

Modifier and Type	Method	Description
String	describeFormat()	Returns a string describing the format of the option.
List<File>	getValue()	Returns the value of the option as a list of File objects.
boolean	isValid(String value)
DirectoryOptions	mustExist()
DirectoryOptions	mustNotExist()

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

Constructor Details

DirectoryOptions

public DirectoryOptions(String description)

Creates a new DirectoryOptions object with the given description.

Parameters:

description - The description of the directory options.

Method Details

describeFormat

public String describeFormat()

Returns a string describing the format of the option.

Specified by:

describeFormat in class Option<List<File>,DirectoryOptions>

Returns:

A string describing the format of the option.

getValue

public List<File> getValue()

Returns the value of the option as a list of File objects.

Specified by:

getValue in class Option<List<File>,DirectoryOptions>

Returns:

The value of the option as a list of File objects.

mustExist

public DirectoryOptions mustExist()

mustNotExist

public DirectoryOptions mustNotExist()

isValid

public boolean isValid(String value)

Specified by:

isValid in class Option<List<File>,DirectoryOptions>

Parameters:

value - value to validate

Returns:

true if value is correct, false otherwise.