scopt.immutable

OptionParser

abstract case class OptionParser[C](programName: Option[String] = scala.None, version: Option[String] = scala.None, errorOnUnknownArgument: Boolean = true) extends GenericOptionParser[C] with Product with Serializable

scopt.immutable.OptionParser is instantiated within your object, set up by implementing options method that returns a sequence of invocations of the various builder methods such as opt method or arg method.

val parser = new scopt.immutable.OptionParser[Config]("scopt", "2.x") { def options = Seq(
  intOpt("f", "foo", "foo is an integer property") { (v: Int, c: Config) => c.copy(foo = v) },
  opt("o", "output", "output") { (v: String, c: Config) => c.copy(bar = v) },
  booleanOpt("xyz", "xyz is a boolean property") { (v: Boolean, c: Config) => c.copy(xyz = v) },
  keyValueOpt("l", "lib", "", "", "load library ")
    { (key: String, value: String, c: Config) => c.copy(libname = key, libfile = value) },
  keyIntValueOpt(None, "max", "", "", "maximum count for ")
    { (key: String, value: Int, c: Config) => c.copy(maxlibname = key, maxcount = value) },
  arg("", "some argument") { (v: String, c: Config) => c.copy(whatnot = v) }
) }
// parser.parse returns Option[C]
parser.parse(args, Config()) map { config =>
  // do stuff
} getOrElse {
  // arguments are bad, usage message will have been displayed
}
Linear Supertypes
Serializable, Serializable, Product, Equals, GenericOptionParser[C], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OptionParser
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. GenericOptionParser
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionParser(programName: String, errorOnUnknownArgument: Boolean)

  2. new OptionParser(errorOnUnknownArgument: Boolean)

  3. new OptionParser(programName: String, version: String)

  4. new OptionParser(programName: String)

  5. new OptionParser()

  6. new OptionParser(programName: Option[String] = scala.None, version: Option[String] = scala.None, errorOnUnknownArgument: Boolean = true)

Abstract Value Members

  1. abstract def options: Seq[OptionDefinition[C]]

    Definition Classes
    GenericOptionParser

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def arg(name: String, description: String)(action: (String, C) ⇒ C): Argument[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

    description

    description in the usage text

    action

    callback function

  7. def argList: Option[Argument[C]]

    Attributes
    protected
    Definition Classes
    GenericOptionParser

  8. def argOpt(name: String, description: String)(action: (String, C) ⇒ C): Argument[C]

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

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

    name

    name in the usage text

    description

    description in the usage text

    action

    callback function

  9. def arglist(name: String, description: String)(action: (String, C) ⇒ C): Argument[C]

    adds a list of arguments invoked by options without - or --.

    adds a list of arguments invoked by options without - or --.

    name

    name in the usage text

    description

    description in the usage text

    action

    callback function

  10. def arglistOpt(name: String, description: String)(action: (String, C) ⇒ C): Argument[C]

    adds an optional list of arguments invoked by options without - or --.

    adds an optional list of arguments invoked by options without - or --.

    name

    name in the usage text

    description

    description in the usage text

    action

    callback function

  11. def arguments: Seq[Argument[C]]

    Attributes
    protected
    Definition Classes
    GenericOptionParser

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  13. def booleanOpt(shortopt: Option[String], longopt: String, valueName: String, description: String)(action: (Boolean, C) ⇒ C): BooleanArgOptionDefinition[C]

  14. def booleanOpt(shortopt: String, longopt: String, valueName: String, description: String)(action: (Boolean, C) ⇒ C): BooleanArgOptionDefinition[C]

  15. def booleanOpt(longopt: String, description: String)(action: (Boolean, C) ⇒ C): BooleanArgOptionDefinition[C]

  16. def booleanOpt(shortopt: String, longopt: String, description: String)(action: (Boolean, C) ⇒ C): BooleanArgOptionDefinition[C]

  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  18. def doubleOpt(shortopt: Option[String], longopt: String, valueName: String, description: String)(action: (Double, C) ⇒ C): DoubleArgOptionDefinition[C]

  19. def doubleOpt(shortopt: String, longopt: String, valueName: String, description: String)(action: (Double, C) ⇒ C): DoubleArgOptionDefinition[C]

  20. def doubleOpt(longopt: String, description: String)(action: (Double, C) ⇒ C): DoubleArgOptionDefinition[C]

  21. def doubleOpt(shortopt: String, longopt: String, description: String)(action: (Double, C) ⇒ C): DoubleArgOptionDefinition[C]

  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. val errorOnUnknownArgument: Boolean

    Definition Classes
    OptionParser → GenericOptionParser

  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  25. def flag(longopt: String, description: String)(action: (C) ⇒ C): FlagOptionDefinition[C]

    adds a flag option invoked by --longopt.

    adds a flag option invoked by --longopt.

    longopt

    long option

    description

    description in the usage text

    action

    callback function

  26. def flag(shortopt: String, longopt: String, description: String)(action: (C) ⇒ C): FlagOptionDefinition[C]

    adds a flag option invoked by -shortopt or --longopt.

    adds a flag option invoked by -shortopt or --longopt.

    shortopt

    short option

    longopt

    long option

    description

    description in the usage text

    action

    callback function

  27. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  28. def help(shortopt: Option[String], longopt: String, description: String): FlagOptionDefinition[C]

  29. def help(shortopt: String, longopt: String, description: String): FlagOptionDefinition[C]

  30. def intOpt(shortopt: Option[String], longopt: String, valueName: String, description: String)(action: (Int, C) ⇒ C): IntArgOptionDefinition[C]

  31. def intOpt(shortopt: String, longopt: String, valueName: String, description: String)(action: (Int, C) ⇒ C): IntArgOptionDefinition[C]

  32. def intOpt(longopt: String, description: String)(action: (Int, C) ⇒ C): IntArgOptionDefinition[C]

  33. def intOpt(shortopt: String, longopt: String, description: String)(action: (Int, C) ⇒ C): IntArgOptionDefinition[C]

  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  35. def keyBooleanValueOpt(shortopt: Option[String], longopt: String, keyName: String, valueName: String, description: String)(action: (String, Boolean, C) ⇒ C): KeyBooleanValueArgOptionDefinition[C]

  36. def keyBooleanValueOpt(shortopt: String, longopt: String, keyName: String, valueName: String, description: String)(action: (String, Boolean, C) ⇒ C): KeyBooleanValueArgOptionDefinition[C]

  37. def keyBooleanValueOpt(longopt: String, description: String)(action: (String, Boolean, C) ⇒ C): KeyBooleanValueArgOptionDefinition[C]

  38. def keyBooleanValueOpt(shortopt: String, longopt: String, description: String)(action: (String, Boolean, C) ⇒ C): KeyBooleanValueArgOptionDefinition[C]

  39. def keyDoubleValueOpt(shortopt: Option[String], longopt: String, keyName: String, valueName: String, description: String)(action: (String, Double, C) ⇒ C): KeyDoubleValueArgOptionDefinition[C]

  40. def keyDoubleValueOpt(shortopt: String, longopt: String, keyName: String, valueName: String, description: String)(action: (String, Double, C) ⇒ C): KeyDoubleValueArgOptionDefinition[C]

  41. def keyDoubleValueOpt(longopt: String, description: String)(action: (String, Double, C) ⇒ C): KeyDoubleValueArgOptionDefinition[C]

  42. def keyDoubleValueOpt(shortopt: String, longopt: String, description: String)(action: (String, Double, C) ⇒ C): KeyDoubleValueArgOptionDefinition[C]

  43. def keyIntValueOpt(shortopt: Option[String], longopt: String, keyName: String, valueName: String, description: String)(action: (String, Int, C) ⇒ C): KeyIntValueArgOptionDefinition[C]

  44. def keyIntValueOpt(shortopt: String, longopt: String, keyName: String, valueName: String, description: String)(action: (String, Int, C) ⇒ C): KeyIntValueArgOptionDefinition[C]

  45. def keyIntValueOpt(longopt: String, description: String)(action: (String, Int, C) ⇒ C): KeyIntValueArgOptionDefinition[C]

  46. def keyIntValueOpt(shortopt: String, longopt: String, description: String)(action: (String, Int, C) ⇒ C): KeyIntValueArgOptionDefinition[C]

  47. def keyValueOpt(shortopt: Option[String], longopt: String, keyName: String, valueName: String, description: String)(action: (String, String, C) ⇒ C): KeyValueArgOptionDefinition[C]

  48. def keyValueOpt(shortopt: String, longopt: String, keyName: String, valueName: String, description: String)(action: (String, String, C) ⇒ C): KeyValueArgOptionDefinition[C]

  49. def keyValueOpt(longopt: String, description: String)(action: (String, String, C) ⇒ C): KeyValueArgOptionDefinition[C]

  50. def keyValueOpt(shortopt: String, longopt: String, description: String)(action: (String, String, C) ⇒ C): KeyValueArgOptionDefinition[C]

  51. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  52. final def notify(): Unit

    Definition Classes
    AnyRef

  53. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  54. def opt(shortopt: Option[String], longopt: String, valueName: String, description: String)(action: (String, C) ⇒ C): ArgOptionDefinition[C]

    adds a String option invoked by -shortopt x or --longopt x.

    adds a String option invoked by -shortopt x or --longopt x.

    shortopt

    short option, or None

    longopt

    long option

    valueName

    value name in the usage text

    description

    description in the usage text

    action

    callback function

  55. def opt(shortopt: String, longopt: String, valueName: String, description: String)(action: (String, C) ⇒ C): ArgOptionDefinition[C]

    adds a String option invoked by -shortopt x or --longopt x.

    adds a String option invoked by -shortopt x or --longopt x.

    shortopt

    short option

    longopt

    long option

    valueName

    value name in the usage text

    description

    description in the usage text

    action

    callback function

  56. def opt(longopt: String, description: String)(action: (String, C) ⇒ C): ArgOptionDefinition[C]

    adds a String option invoked by --longopt x.

    adds a String option invoked by --longopt x.

    longopt

    long option

    description

    description in the usage text

    action

    callback function

  57. def opt(shortopt: String, longopt: String, description: String)(action: (String, C) ⇒ C): ArgOptionDefinition[C]

    adds a String option invoked by -shortopt x or --longopt x.

    adds a String option invoked by -shortopt x or --longopt x.

    shortopt

    short option

    longopt

    long option

    description

    description in the usage text

    action

    callback function

  58. def opts: Seq[OptionDefinition[C]]

    Attributes
    protected
    Definition Classes
    GenericOptionParser

  59. def parse(args: Seq[String], init: C): Option[C]

    parses the given args.

    parses the given args.

    returns

    true if successful, false otherwise

    Definition Classes
    GenericOptionParser

  60. val programName: Option[String]

    Definition Classes
    OptionParser → GenericOptionParser

  61. def separator(description: String): SeparatorDefinition[C]

  62. def showUsage: Unit

    Definition Classes
    GenericOptionParser

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

    Definition Classes
    AnyRef

  64. def usage: String

    Definition Classes
    GenericOptionParser

  65. val version: Option[String]

    Definition Classes
    OptionParser → GenericOptionParser

  66. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  67. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  68. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenericOptionParser[C]

Inherited from AnyRef

Inherited from Any

Ungrouped