case class LongNamedPropertyOption(name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
Descriptor for a property option with a "long" name (like --Props key1=value1 key2=value2).
- name
Internal name for the option.
- descr
Description for this property option, for help description.
- converter
The converter for this option.
- keyName
Name for 'key' part of this option arg name, as it will appear in help option definition.
- valueName
Name for 'value' part of this option arg name, as it will appear in help option definition.
- hidden
If set to true, then this option will be hidden from generated help output.
- Source
- CliOptions.scala
- Alphabetic
- By Inheritance
- LongNamedPropertyOption
- Serializable
- Serializable
- Product
- Equals
- CliOption
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
LongNamedPropertyOption(name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean)
- name
Internal name for the option.
- descr
Description for this property option, for help description.
- converter
The converter for this option.
- keyName
Name for 'key' part of this option arg name, as it will appear in help option definition.
- valueName
Name for 'value' part of this option arg name, as it will appear in help option definition.
- hidden
If set to true, then this option will be hidden from generated help output.
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
-
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.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
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.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
def
default: () ⇒ Some[Map[Nothing, Nothing]]
Function that provides an optional default value for this option.
Function that provides an optional default value for this option.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
val
descr: String
Description for this option that will be presented to the user
Description for this option that will be presented to the user
- Definition Classes
- LongNamedPropertyOption → CliOption
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
val
hidden: Boolean
If true, then this option is not shown in help output.
If true, then this option is not shown in help output.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPositional: Boolean
True for trailing argument option type, false for everything else.
True for trailing argument option type, false for everything else.
- Definition Classes
- LongNamedPropertyOption → CliOption
- val keyName: String
-
def
longNames: List[String]
Long names for this option.
Long names for this option.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
val
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.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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?
- Definition Classes
- LongNamedPropertyOption → CliOption
-
def
requiredShortNames: Nil.type
Short names that were explicitly set for this option.
Short names that were explicitly set for this option.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
def
shortNames: Nil.type
Short names that are suggested by option implementation.
Short names that are suggested by option implementation.
- Definition Classes
- LongNamedPropertyOption → CliOption
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- LongNamedPropertyOption → AnyRef → Any
-
def
validator: (Any) ⇒ Boolean
Validator for the option value.
Validator for the option value.
- Definition Classes
- LongNamedPropertyOption → CliOption
- val valueName: String
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()