class Option extends AnyRef
Models command line options. Options are values passed to a command line interface using -x or --x. Supported syntaxes depend on the parser.
Short name is generally used with a single dash, while long name requires a double-dash.
- Alphabetic
- By Inheritance
- Option
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Option(_asJava: core.cli.Option)
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
addChoice(value: String): Option
Sets the list of values accepted by this option.
Sets the list of values accepted by this option. If the value set by the user does not match once of these values, a io.vertx.core.cli.InvalidValueException exception is thrown.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: core.cli.Option
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def getArgName: String
- def getChoices: Set[String]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDefaultValue: String
- def getDescription: String
- def getLongName: String
- def getShortName: String
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isFlag: Boolean
- def isHelp: Boolean
- def isHidden: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isMultiValued: Boolean
- def isRequired: Boolean
- def isSingleValued: Boolean
-
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
setArgName(value: String): Option
Sets te arg name for this option.
- def setChoices(value: Set[String]): Option
-
def
setDefaultValue(value: String): Option
Sets the default value of this option
-
def
setDescription(value: String): Option
Sets te description of this option.
-
def
setFlag(value: Boolean): Option
Configures the current Option to be a flag.
Configures the current Option to be a flag. It will be evaluated to
true
if it's found in the command line. If you need a flag that may receive a value, use, in this order:option.setFlag(true).setSingleValued(true)
-
def
setHelp(value: Boolean): Option
Sets whether or not this option is a "help" option
-
def
setHidden(value: Boolean): Option
Sets whether or not this option should be hidden
-
def
setLongName(value: String): Option
Sets the long name of this option.
-
def
setMultiValued(value: Boolean): Option
Sets whether or not this option can receive several values.
-
def
setRequired(value: Boolean): Option
Sets whether or not this option is mandatory.
-
def
setShortName(value: String): Option
Sets the short name of this option.
-
def
setSingleValued(value: Boolean): Option
Sets whether or not this option can receive a value.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
- @native() @throws( ... )