scopt/scopt/OptionDef

OptionDef

class OptionDef[A, C](_id: Int, _kind: OptionDefKind, _name: String, _shortOpt: Option[String], _keyName: Option[String], _valueName: Option[String], _desc: String, _action: (A, C) => C, _validations: Seq[A => Either[String, Unit]], _configValidations: Seq[C => Either[String, Unit]], _parentId: Option[Int], _minOccurs: Int, _maxOccurs: Int, _isHidden: Boolean, _fallback: Option[() => A], _defCallback: OptionDefCallback[C])(evidence$1: Read[A])
class Object
trait Matchable
class Any

Value members

Constructors

def this(kind: OptionDefKind, name: String, defCallback: OptionDefCallback[C])(evidence$1: Read[A])
def this(kind: OptionDefKind, name: String)(evidence$1: Read[A])

Methods

def action(f: (A, C) => C): OptionDef[A, C]
Adds a callback function.
def foreach(f: A => Unit): OptionDef[A, C]
Adds a callback function.
override def toString: String
Definition Classes
Any
def abbr(x: String): OptionDef[A, C]
Adds short option -x.
def minOccurs(n: Int): OptionDef[A, C]
Requires the option to appear at least n times.
def maxOccurs(n: Int): OptionDef[A, C]
Allows the argument to appear at most n times.
def required(): OptionDef[A, C]
Requires the option to appear at least once.
def optional(): OptionDef[A, C]
Changes the option to be optional.
def unbounded(): OptionDef[A, C]
Allows the argument to appear multiple times.
def hidden(): OptionDef[A, C]
Hides the option in any usage text.
def text(x: String): OptionDef[A, C]
Adds description in the usage text.
def valueName(x: String): OptionDef[A, C]
Adds value name used in the usage text.
def keyName(x: String): OptionDef[A, C]
Adds key name used in the usage text.
def keyValueName(k: String, v: String): OptionDef[A, C]
Adds key and value names used in the usage text.
def validate(f: A => Either[String, Unit]): OptionDef[A, C]
Adds custom validation.
def withFallback(to: () => A): OptionDef[A, C]
provides a default to fallback to, e.g. for System.getenv
def children(xs: OptionDef[, C]*): OptionDef[A, C]
Adds opt/arg under this command.
def getMinOccurs: Int
def getMaxOccurs: Int
def isHidden: Boolean
def hasFallback: Boolean
def desc: String
def shortOpt: Option[String]
def valueName: Option[String]
def shortDescription: String
def fullName: String

Fields

val name: String