Packages

c

scopt

OptionDef

class OptionDef[A, C] extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionDef
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionDef(parser: OptionParser[C], kind: OptionDefKind, name: String)(implicit arg0: Read[A])
  2. new OptionDef(_parser: OptionParser[C], _id: Int, _kind: OptionDefKind, _name: String, _shortOpt: Option[String], _keyName: Option[String], _valueName: Option[String], _desc: String, _action: (A, C) ⇒ C, _validations: Seq[(A) ⇒ Either[String, Unit]], _configValidations: Seq[(C) ⇒ Either[String, Unit]], _parentId: Option[Int], _minOccurs: Int, _maxOccurs: Int, _isHidden: Boolean, _fallback: Option[() ⇒ A])(implicit arg0: Read[A])

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 abbr(x: String): OptionDef[A, C]

    Adds short option -x.

  5. def action(f: (A, C) ⇒ C): OptionDef[A, C]

    Adds a callback function.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def children(xs: OptionDef[_, C]*): OptionDef[A, C]

    Adds opt/arg under this command.

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def desc: String
  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 foreach(f: (A) ⇒ Unit): OptionDef[A, C]

    Adds a callback function.

  14. def fullName: String
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getFallback: A
  17. def getMaxOccurs: Int
  18. def getMinOccurs: Int
  19. def hasFallback: Boolean
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hidden(): OptionDef[A, C]

    Hides the option in any usage text.

  22. def isHidden: Boolean
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def keyName(x: String): OptionDef[A, C]

    Adds key name used in the usage text.

  25. def keyValueName(k: String, v: String): OptionDef[A, C]

    Adds key and value names used in the usage text.

  26. def maxOccurs(n: Int): OptionDef[A, C]

    Allows the argument to appear at most n times.

  27. def minOccurs(n: Int): OptionDef[A, C]

    Requires the option to appear at least n times.

  28. val name: String
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def optional(): OptionDef[A, C]

    Changes the option to be optional.

  33. def required(): OptionDef[A, C]

    Requires the option to appear at least once.

  34. def shortDescription: String
  35. def shortOpt: Option[String]
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def text(x: String): OptionDef[A, C]

    Adds description in the usage text.

  38. def toString(): String
    Definition Classes
    OptionDef → AnyRef → Any
  39. def unbounded(): OptionDef[A, C]

    Allows the argument to appear multiple times.

  40. def validate(f: (A) ⇒ Either[String, Unit]): OptionDef[A, C]

    Adds custom validation.

  41. def valueName: Option[String]
  42. def valueName(x: String): OptionDef[A, C]

    Adds value name used in the usage text.

  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
    @native() @throws( ... )
  46. def withFallback(to: () ⇒ A): OptionDef[A, C]

    provides a default to fallback to, e.g.

    provides a default to fallback to, e.g. for System.getenv

Inherited from AnyRef

Inherited from Any

Ungrouped