scallop/org.rogach.scallop/CliOption

CliOption

sealed trait CliOption

Parent class for option descriptors. Each option descriptor contains everything needed to parse that option - option names, defaults, converters, validators, etc.

Parent class for option descriptors. Each option descriptor contains everything needed to parse that option - option names, defaults, converters, validators, etc.

class Object
trait Matchable
class Any

Value members

Abstract methods

def argLine(sh: List[Char]): String

The line that would be printed as definition of this arg in help output.

The line that would be printed as definition of this arg in help output.

def converter: ValueConverter[_]

Converter for pure string arguments to the needed type of this option.

Converter for pure string arguments to the needed type of this option.

def default: () => Option[Any]

Function that provides an optional default value for this option.

Function that provides an optional default value for this option.

def descr: String

Description for this option that will be presented to the user

Description for this option that will be presented to the user

def helpInfo(sh: List[Char]): List[HelpInfo]

List of argument lines, descriptions to them, and optional default values.

List of argument lines, descriptions to them, and optional default values.

def hidden: Boolean

If true, then this option is not shown in help output.

If true, then this option is not shown in help output.

def isPositional: Boolean

True for trailing argument option type, false for everything else.

True for trailing argument option type, false for everything else.

def longNames: List[String]

Long names for this option.

Long names for this option.

def name: String

Internal name of this option - the one that would be used to access parsed values.

Internal name of this option - the one that would be used to access parsed values.

def required: Boolean

Is there a requirement to have at least one invocation of this option?

Is there a requirement to have at least one invocation of this option?

def requiredShortNames: List[Char]

Short names that were explicitly set for this option.

Short names that were explicitly set for this option.

def shortNames: List[Char]

Short names that are suggested by option implementation.

Short names that are suggested by option implementation.

def validator: Any => Boolean

Validator for the option value.

Validator for the option value.