org.cyclopsgroup.jcli.spi

Interface Option

public interface Option

Meta data for an option

Author:

Jiaqi Guo

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getDisplayName()
String	getLongName()
String	getName()
boolean	isFlag()
boolean	isMultiValue()
boolean	isRequired()

Method Detail

getDefaultValue

String getDefaultValue()

Returns:

Implied value of option, NULL if not specified

getDescription

String getDescription()

Returns:

String description of the option

getDisplayName

String getDisplayName()

Returns:

Display name of option value

getLongName

String getLongName()

Returns:

Long option name used in command line

getName

String getName()

Returns:

Short option name used in command line

isFlag

boolean isFlag()

Returns:

True if option doesn't take a value

isMultiValue

boolean isMultiValue()

Returns:

True if there can be more than one of this option

isRequired

boolean isRequired()

Returns:

True if option is required