case class ParamDef(names: Seq[String], parseAndSet: (String, Option[String]) => Unit, missing: () => Unit, isFlag: Boolean, repeatPositional: Boolean, absorbRemaining: Boolean) extends Product with Serializable
A parameter definition is the low-level building block to define the grammar of a command-line, and its functionality.
ParamDefs associate parameter names to actions that are invoked by Parser.parse() in certain situations.
- names
All names that may be used by this parameter. If a name starts with
-, it is considered a "named" parameter, otherwise it is considered a "positional" parameter. Arguments associated to named parameters may appear in any order on the command line, as long as they are prefixed by the parameter's name. Positional parameters are given arguments in the order they appear in.- parseAndSet
A function that is invoked anytime this parameter is encountered on the command line. In case of an named param, the first element is the actual name used, and the second element is the argument or None if no argument followed. In case of a position param, no name is given and the argument value is always defined.
- missing
A function that is invoked if this parameter has not been encountered at all.
- isFlag
Indicates if this named parameter is a flag, i.e. one that never accepts an argument. In case its name is encountered, its value is set to "true". Has no effect on positional parameters.
- repeatPositional
If this is a positional parameter, it will be the parser will repeat it indefinitely.
- absorbRemaining
Treat all subsequent parameters as positionals, regardless of their name. This can be useful for constructing nested commands.
- Alphabetic
- By Inheritance
- ParamDef
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ParamDef(names: Seq[String], parseAndSet: (String, Option[String]) => Unit, missing: () => Unit, isFlag: Boolean, repeatPositional: Boolean, absorbRemaining: Boolean)
- names
All names that may be used by this parameter. If a name starts with
-, it is considered a "named" parameter, otherwise it is considered a "positional" parameter. Arguments associated to named parameters may appear in any order on the command line, as long as they are prefixed by the parameter's name. Positional parameters are given arguments in the order they appear in.- parseAndSet
A function that is invoked anytime this parameter is encountered on the command line. In case of an named param, the first element is the actual name used, and the second element is the argument or None if no argument followed. In case of a position param, no name is given and the argument value is always defined.
- missing
A function that is invoked if this parameter has not been encountered at all.
- isFlag
Indicates if this named parameter is a flag, i.e. one that never accepts an argument. In case its name is encountered, its value is set to "true". Has no effect on positional parameters.
- repeatPositional
If this is a positional parameter, it will be the parser will repeat it indefinitely.
- absorbRemaining
Treat all subsequent parameters as positionals, regardless of their name. This can be useful for constructing nested commands.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val absorbRemaining: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val isFlag: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNamed: Boolean
- val missing: () => Unit
- val names: Seq[String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val parseAndSet: (String, Option[String]) => Unit
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val repeatPositional: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated