Packages

final class ValidOption extends Product with Serializable

Represents a valid command-line option.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValidOption
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ValidOption(name: String, path: List[String], isCanonical: Boolean, shape: ParameterShape)

    name

    the syntax that is accepted from the command-line. Normally the same as path.mkString(".") for canonicalized options, but non-canonical options may drop a few prefixes from the path.

    path

    the nested keys to insert to update this option. For example, the path List("a", "b", "c") becomes the JSON object {"a": {"b": {"c": PARSED_OPTION }}} .

    isCanonical

    a valid option can have many different names, is this the canonical name of this option? For example

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 canEqual(obj: Any): Boolean
    Definition Classes
    ValidOption → Equals
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: Any): Boolean
    Definition Classes
    ValidOption → Equals → AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    ValidOption → AnyRef → Any
  12. val isCanonical: 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. val path: List[String]
  19. def productArity: Int
    Definition Classes
    ValidOption → Product
  20. def productElement(n: Int): Any
    Definition Classes
    ValidOption → Product
  21. def productElementName(n: Int): String
    Definition Classes
    ValidOption → Product
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. def productIterator: Iterator[Any]
    Definition Classes
    Product
  24. def productPrefix: String
    Definition Classes
    ValidOption → Product
  25. val shape: ParameterShape
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    ValidOption → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. def withIsCanonical(isCanonical: Boolean): ValidOption
  32. def withName(name: String): ValidOption
  33. def withPath(path: List[String]): ValidOption
  34. def withShape(shape: ParameterShape): ValidOption

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped