c

scopt

OptionParser

abstract class OptionParser[C] extends OptionDefCallback[C]

scopt.immutable.OptionParser is instantiated within your object, set up by an (ordered) sequence of invocations of the various builder methods such as opt method or arg method.

val parser = new scopt.OptionParser[Config]("scopt") {
  head("scopt", "4.x")

  opt[Int]('f', "foo").action( (x, c) =>
    c.copy(foo = x) ).text("foo is an integer property")

  opt[File]('o', "out").required().valueName("<file>").
    action( (x, c) => c.copy(out = x) ).
    text("out is a required file property")

  opt[(String, Int)]("max").action({
      case ((k, v), c) => c.copy(libName = k, maxCount = v) }).
    validate( x =>
      if (x._2 > 0) success
      else failure("Value <max> must be >0") ).
    keyValueName("<libname>", "<max>").
    text("maximum count for <libname>")

  opt[Seq[File]]('j', "jars").valueName("<jar1>,<jar2>...").action( (x,c) =>
    c.copy(jars = x) ).text("jars to include")

  opt[Map[String,String]]("kwargs").valueName("k1=v1,k2=v2...").action( (x, c) =>
    c.copy(kwargs = x) ).text("other arguments")

  opt[Unit]("verbose").action( (_, c) =>
    c.copy(verbose = true) ).text("verbose is a flag")

  opt[Unit]("debug").hidden().action( (_, c) =>
    c.copy(debug = true) ).text("this option is hidden in the usage text")

  help("help").text("prints this usage text")

  arg[File]("<file>...").unbounded().optional().action( (x, c) =>
    c.copy(files = c.files :+ x) ).text("optional unbounded args")

  note("some notes.".newline)

  cmd("update").action( (_, c) => c.copy(mode = "update") ).
    text("update is a command.").
    children(
      opt[Unit]("not-keepalive").abbr("nk").action( (_, c) =>
        c.copy(keepalive = false) ).text("disable keepalive"),
      opt[Boolean]("xyz").action( (x, c) =>
        c.copy(xyz = x) ).text("xyz is a boolean property"),
      opt[Unit]("debug-update").hidden().action( (_, c) =>
        c.copy(debug = true) ).text("this option is hidden in the usage text"),
      checkConfig( c =>
        if (c.keepalive && c.xyz) failure("xyz cannot keep alive")
        else success )
    )
}

// parser.parse returns Option[C]
parser.parse(args, Config()) match {
  case Some(config) =>
    // do stuff

  case None =>
    // arguments are bad, error message will have been displayed
}
Self Type
OptionParser[C]
Linear Supertypes
OptionDefCallback[C], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionParser
  2. OptionDefCallback
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OptionParser(programName: String)

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

    adds an argument invoked by an option without - or --.

    adds an argument invoked by an option without - or --.

    name

    name in the usage text

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def checkConfig(f: (C) => Either[String, Unit]): OptionDef[Unit, C]

    adds final check.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def cmd(name: String): OptionDef[Unit, C]

    adds a command invoked by an option without - or --.

    adds a command invoked by an option without - or --.

    name

    name of the command

  9. def displayToErr(msg: String): Unit
  10. def displayToOut(msg: String): Unit
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def errorOnUnknownArgument: Boolean
  14. def failure(msg: String): Either[String, Unit]

    call this to express failure in custom validation.

  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def head(xs: String*): OptionDef[Unit, C]

    adds usage text.

  19. def header: String
  20. def help(x: Char, name: String): OptionDef[Unit, C]

    adds an option invoked by -x or --name that displays usage text and exits.

    adds an option invoked by -x or --name that displays usage text and exits.

    x

    name of the short option

    name

    name of the option

  21. def help(name: String): OptionDef[Unit, C]

    adds an option invoked by --name that displays usage text and exits.

    adds an option invoked by --name that displays usage text and exits.

    name

    name of the option

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def makeDef[A](kind: OptionDefKind, name: String)(implicit arg0: Read[A]): OptionDef[A, C]
    Attributes
    protected
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def note(x: String): OptionDef[Unit, C]

    adds usage text.

  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def opt[A](x: Char, name: String)(implicit arg0: Read[A]): OptionDef[A, C]

    adds an option invoked by -x value or --name value.

    adds an option invoked by -x value or --name value.

    x

    name of the short option

    name

    name of the option

  29. def opt[A](name: String)(implicit arg0: Read[A]): OptionDef[A, C]

    adds an option invoked by --name x.

    adds an option invoked by --name x.

    name

    name of the option

  30. val options: ListBuffer[OptionDef[_, C]]
    Attributes
    protected
  31. def parse(args: Seq[String], init: C): Option[C]

    parses the given args.

  32. def renderingMode: RenderingMode
  33. def reportError(msg: String): Unit
  34. def reportWarning(msg: String): Unit
  35. def showUsageOnError: Option[Boolean]
  36. def success: Either[String, Unit]

    call this to express success in custom validation.

  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def terminate(exitState: Either[String, Unit]): Unit
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. def usage: String
  41. def version(x: Char, name: String): OptionDef[Unit, C]

    adds an option invoked by -x or --name that displays header text and exits.

    adds an option invoked by -x or --name that displays header text and exits.

    x

    name of the short option

    name

    name of the option

  42. def version(name: String): OptionDef[Unit, C]

    adds an option invoked by --name that displays header text and exits.

    adds an option invoked by --name that displays header text and exits.

    name

    name of the option

  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from OptionDefCallback[C]

Inherited from AnyRef

Inherited from Any

Ungrouped