vertx-lang-scala-docs_2.12 3.4.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package cli
  Definition Classes
    core
- Argument
- CLI
- CommandLine
- Option

c

io.vertx.scala.core.cli

# Option 

###
Companion object Option

#### 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.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Option
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new Option(_asJava: core.cli.Option)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  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.

5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def asJava: core.cli.Option
7.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
8.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
9.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
10.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
11.  def getArgName: String
12.  def getChoices: Set[String]
13.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
14.  def getDefaultValue: String
15.  def getDescription: String
16.  def getLongName: String
17.  def getShortName: String
18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
19.  def isFlag: Boolean
20.  def isHelp: Boolean
21.  def isHidden: Boolean
22.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
23.  def isMultiValued: Boolean
24.  def isRequired: Boolean
25.  def isSingleValued: Boolean
26.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
27.  final def notify(): Unit
    Definition Classes
      AnyRef
28.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
29.  def setArgName(value: String): Option

    Sets te arg name for this option.

30.  def setChoices(value: Set[String]): Option
31.  def setDefaultValue(value: String): Option

    Sets the default value of this option

32.  def setDescription(value: String): Option

    Sets te description of this option.

33.  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)

34.  def setHelp(value: Boolean): Option

    Sets whether or not this option is a "help" option

35.  def setHidden(value: Boolean): Option

    Sets whether or not this option should be hidden

36.  def setLongName(value: String): Option

    Sets the long name of this option.

37.  def setMultiValued(value: Boolean): Option

    Sets whether or not this option can receive several values.

38.  def setRequired(value: Boolean): Option

    Sets whether or not this option is mandatory.

39.  def setShortName(value: String): Option

    Sets the short name of this option.

40.  def setSingleValued(value: Boolean): Option

    Sets whether or not this option can receive a value.

41.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
42.  def toString(): String
    Definition Classes
      AnyRef → Any
43.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
44.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
45.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped