Class

scopt

OptionDef

Related Doc: package scopt

Permalink

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(kind: OptionDefKind, name: String)(implicit arg0: Read[A])

    Permalink
  2. new OptionDef(kind: OptionDefKind, name: String, defCallback: OptionDefCallback[C])(implicit arg0: Read[A])

    Permalink
  3. new OptionDef(_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], _defCallback: OptionDefCallback[C])(implicit arg0: Read[A])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def abbr(x: String): OptionDef[A, C]

    Permalink

    Adds short option -x.

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

    Permalink

    Adds a callback function.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def children(xs: OptionDef[_, C]*): OptionDef[A, C]

    Permalink

    Adds opt/arg under this command.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def desc: String

    Permalink
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def foreach(f: (A) ⇒ Unit): OptionDef[A, C]

    Permalink

    Adds a callback function.

  14. def fullName: String

    Permalink
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getFallback: A

    Permalink
  17. def getMaxOccurs: Int

    Permalink
  18. def getMinOccurs: Int

    Permalink
  19. def hasFallback: Boolean

    Permalink
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hidden(): OptionDef[A, C]

    Permalink

    Hides the option in any usage text.

  22. def isHidden: Boolean

    Permalink
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def keyName(x: String): OptionDef[A, C]

    Permalink

    Adds key name used in the usage text.

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

    Permalink

    Adds key and value names used in the usage text.

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

    Permalink

    Allows the argument to appear at most n times.

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

    Permalink

    Requires the option to appear at least n times.

  28. val name: String

    Permalink
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def optional(): OptionDef[A, C]

    Permalink

    Changes the option to be optional.

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

    Permalink

    Requires the option to appear at least once.

  34. def shortDescription: String

    Permalink
  35. def shortOpt: Option[String]

    Permalink
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def text(x: String): OptionDef[A, C]

    Permalink

    Adds description in the usage text.

  38. def toString(): String

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

    Permalink

    Allows the argument to appear multiple times.

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

    Permalink

    Adds custom validation.

  41. def valueName: Option[String]

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

    Permalink

    Adds value name used in the usage text.

  43. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def withFallback(to: () ⇒ A): OptionDef[A, C]

    Permalink

    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