vertx-lang-scala-docs_2.12 3.5.0 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

# CommandLine 

###
Companion object CommandLine

#### class CommandLine extends AnyRef

The parser transforms a CLI (a model) into an io.vertx.scala.core.cli.CommandLine. This io.vertx.scala.core.cli.CommandLine has stored the argument and option values. Only instance of parser should create objects of this type.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. CommandLine
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new CommandLine(_asJava: AnyRef)

### 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 acceptMoreValues(option: Option): Boolean

   Checks whether or not the given option accept more values.

   Checks whether or not the given option accept more values.

   option

     the optionsee Option

   returns

     true if the option accepts more values, false otherwise.

5.  def allArguments(): Buffer[String]

   returns

     the ordered list of arguments. Arguments are command line arguments not matching an option.

6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def asJava: AnyRef
8.  def cli(): CLI

   returns

     the model of this command line object.

9.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
10.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
11.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
12.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
13.  def getArgumentValue[T](index: Int)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): scala.Option[T]

    Gets the value of an argument with the given index.

    Gets the value of an argument with the given index.

    index

      the index

    returns

      the value, `null` if not set

14.  def getArgumentValue[T](name: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): scala.Option[T]

    Gets the value of an argument with the matching name (arg name).

    Gets the value of an argument with the matching name (arg name).

    name

      the name

    returns

      the value, `null` if not set

15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
16.  def getOptionValue[T](name: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): scala.Option[T]

    Gets the value of an option with the matching name (can be the long name, short name or arg name).

    Gets the value of an option with the matching name (can be the long name, short name or arg name).

    name

      the name

    returns

      the value, `null` if not set

17.  def getRawValueForArgument(arg: Argument): scala.Option[String]

    Gets the raw value of the given argument.

    Gets the raw value of the given argument. Raw values are the values as given in the user command line.

    arg

      the argumentsee Argument

    returns

      the value, `null` if none.

18.  def getRawValueForOption(option: Option): scala.Option[String]

    Gets the raw value of the given option.

    Gets the raw value of the given option. Raw values are the values as given in the user command line.

    option

      the optionsee Option

    returns

      the value, `null` if none.

19.  def getRawValues(option: Option): Buffer[String]

    Gets the raw values of the given option.

    Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

    option

      the optionsee Option

    returns

      the list of values, empty if none

20.  def getRawValuesForArgument(argument: Argument): Buffer[String]

    Gets the raw values of the given argument.

    Gets the raw values of the given argument. Raw values are simple "String", not converted to the argument type.

    argument

      the argumentsee Argument

    returns

      the list of values, empty if none

21.  def getRawValuesForOption(option: Option): Buffer[String]

    Gets the raw values of the given option.

    Gets the raw values of the given option. Raw values are simple "String", not converted to the option type.

    option

      the optionsee Option

    returns

      the list of values, empty if none

22.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
23.  def isArgumentAssigned(arg: Argument): Boolean

    Checks whether or not the given argument has been assigned in the command line.

    Checks whether or not the given argument has been assigned in the command line.

    arg

      the argumentsee Argument

    returns

      `true` if the argument has received a value, false otherwise.

24.  def isAskingForHelp(): Boolean

    Checks whether or not the user has passed a "help" option and is asking for help.

    Checks whether or not the user has passed a "help" option and is asking for help.

    returns

      `true` if the user command line has enabled a "Help" option, false otherwise.

25.  def isFlagEnabled(name: String): Boolean

    Gets the value of an option marked as a flag.

    Gets the value of an option marked as a flag.

    Calling this method an a non-flag option throws an IllegalStateException.

    name

      the option name

    returns

      `true` if the flag has been set in the command line, `false` otherwise.

26.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
27.  def isOptionAssigned(option: Option): Boolean

    Checks whether or not the given option has been assigned in the command line.

    Checks whether or not the given option has been assigned in the command line.

    option

      the optionsee Option

    returns

      `true` if the option has received a value, false otherwise.

28.  def isSeenInCommandLine(option: Option): Boolean

    Checks whether or not the given option has been seen in the user command line.

    Checks whether or not the given option has been seen in the user command line.

    option

      the optionsee Option

    returns

      `true` if the user command line has used the option

29.  def isValid(): Boolean

    Checks whether or not the command line is valid, i.e.

    Checks whether or not the command line is valid, i.e. all constraints from arguments and options have been satisfied. This method is used when the parser validation is disabled.

    returns

      `true` if the current CommandLine object is valid. false otherwise.

30.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
31.  final def notify(): Unit
    Definition Classes
      AnyRef
32.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
33.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
34.  def toString(): String
    Definition Classes
      AnyRef → Any
35.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
36.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
37.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped