case class CmdOption(name: String, description: String, isFlag: Boolean = false) extends Product with Serializable

Represents ErgoTool option description.

Options can be used in command line to specify parameters to be used by the command during its operation. The command line passed to ErgoTool is split into parts (args) by whitespaces, so that option name and value are represented by two consecutive parts.

In the command line an option is given using the following syntax --optionName optionValue, where the option name should be prefixed with -- in the command line, and option value is given by the next part of the command line.

If a CmdOption instance has CmdOption.isFlag set to true then such option doesn't have optionValue part and the option is interpreted as Boolean value (true if it is present, false otherwise)

name

The name of this option excluding prefix -- (should not contain whitespaces) (Examples: conf for ConfigOption and dry-run for DryRunOption)

description

is a user readable description of the option

isFlag

is set to true if the option is a flag option which doesn't have optionValue part (e.g. --ni or --dry-run)

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
ConfigOption, DryRunOption, PrintJsonOption
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CmdOption
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CmdOption(name: String, description: String, isFlag: Boolean = false)

    name

    The name of this option excluding prefix -- (should not contain whitespaces) (Examples: conf for ConfigOption and dry-run for DryRunOption)

    description

    is a user readable description of the option

    isFlag

    is set to true if the option is a flag option which doesn't have optionValue part (e.g. --ni or --dry-run)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def cmdText: String

    The text of the command line with the name of this option.

  7. val description: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def helpString: String

    The string printed for this option in the Usage Help output.

  12. val isFlag: Boolean
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val name: String
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped