Packages

final class OptionParser[T, D0] extends Parser[Option[T]] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionParser
  2. Serializable
  3. Product
  4. Equals
  5. Parser
  6. ParserMethods
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OptionParser(underlying: Aux[T, D0])

Type Members

  1. type D = D0

    Intermediate result type.

    Intermediate result type.

    Used during parsing, while checking the arguments one after the other.

    If parsing succeeds, a T can be built from the D at the end of parsing.

    Definition Classes
    OptionParser → Parser

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 args: Seq[Arg]

    Arguments this parser accepts.

    Arguments this parser accepts.

    Used to generate help / usage messages.

    Definition Classes
    OptionParser → ParserMethods
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def canEqual(obj: Any): Boolean
    Definition Classes
    OptionParser → Equals
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def complete(args: Seq[String], index: Int, completer: Completer[Option[T]], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): List[CompletionItem]
    Definition Classes
    ParserMethods
  9. def defaultIgnoreUnrecognized: Boolean
    Definition Classes
    OptionParser → ParserMethods
  10. def defaultNameFormatter: Formatter[Name]
    Definition Classes
    OptionParser → ParserMethods
  11. def defaultStopAtFirstUnrecognized: Boolean
    Definition Classes
    OptionParser → ParserMethods
  12. final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): Either[Error, (Option[T], RemainingArgs)]
    Definition Classes
    ParserMethods
  13. final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean): Either[Error, (Option[T], RemainingArgs)]
    Definition Classes
    ParserMethods
  14. final def detailedParse(args: Seq[String]): Either[Error, (Option[T], RemainingArgs)]

    Keeps the remaining args before and after a possible -- separated

    Keeps the remaining args before and after a possible -- separated

    Definition Classes
    ParserMethods
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(obj: Any): Boolean
    Definition Classes
    OptionParser → Equals → AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def get(d: D, nameFormatter: Formatter[Name]): Right[Error, Option[T]]

    Get the final result from the final intermediate value.

    Get the final result from the final intermediate value.

    Typically fails if some mandatory arguments were not specified, so are missing in d, preventing building a T out of it.

    returns

    in case of success, a T wrapped in scala.Right; else, an error message, wrapped in caseapp.core.Error and scala.Left

    Definition Classes
    OptionParser → ParserMethods
  19. final def get(d: D): Either[Error, Option[T]]

    Get the final result from the final intermediate value.

    Get the final result from the final intermediate value.

    Typically fails if some mandatory arguments were not specified, so are missing in d, preventing building a T out of it.

    returns

    in case of success, a T wrapped in scala.Right; else, an error message, wrapped in caseapp.core.Error and scala.Left

    Definition Classes
    ParserMethods
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    OptionParser → AnyRef → Any
  22. def ignoreUnrecognized: Aux[Option[T], D]
    Definition Classes
    Parser
  23. def init: D

    Initial value used to accumulate parsed arguments.

    Initial value used to accumulate parsed arguments.

    Definition Classes
    OptionParser → ParserMethods
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def map[U](f: (Option[T]) => U): Aux[U, D]
    Definition Classes
    Parser
  26. def nameFormatter(f: Formatter[Name]): Aux[Option[T], D]
    Definition Classes
    Parser
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def parse(args: Seq[String]): Either[Error, (Option[T], Seq[String])]
    Definition Classes
    ParserMethods
  31. def productArity: Int
    Definition Classes
    OptionParser → Product
  32. def productElement(n: Int): Any
    Definition Classes
    OptionParser → Product
  33. def productElementName(n: Int): String
    Definition Classes
    OptionParser → Product
  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. def productIterator: Iterator[Any]
    Definition Classes
    Product
  36. def productPrefix: String
    Definition Classes
    OptionParser → Product
  37. final def scan(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): (Either[(Error, Either[D, Option[T]]), Option[T]], RemainingArgs, List[Parser.Step])
    Definition Classes
    ParserMethods
  38. def step(args: List[String], index: Int, d: D, nameFormatter: Formatter[Name]): Either[(Error, Arg, List[String]), Option[(D, Arg, List[String])]]

    Process the next argument.

    Process the next argument.

    If some arguments were successfully processed (third case in return below), the returned remaining argument sequence must be shorter than the passed args.

    This method doesn't fully process args. It tries just to parse *one* argument (typically one option --foo and its value bar, so two elements from args - it can also be only one element in case of a flag), if possible. If you want to fully process a sequence of arguments, see parse or detailedParse.

    returns

    if no argument were parsed, Right(None); if an error occurred, an error message wrapped in caseapp.core.Error and scala.Left; else the next intermediate value and the remaining arguments wrapped in scala.Some and scala.Right.

    Definition Classes
    OptionParser → ParserMethods
  39. def step(args: List[String], index: Int, d: D): Either[(Error, Arg, List[String]), Option[(D, Arg, List[String])]]
    Definition Classes
    ParserMethods
  40. def stopAtFirstUnrecognized: Aux[Option[T], D]
    Definition Classes
    Parser
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toString(): String
    Definition Classes
    OptionParser → AnyRef → Any
  43. val underlying: Aux[T, D0]
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. def withDefaultOrigin(origin: String): Aux[Option[T], D]
    Definition Classes
    OptionParser → Parser
  48. final def withFullHelp: Parser[WithFullHelp[Option[T]]]
    Definition Classes
    Parser
  49. final def withHelp: Parser[WithHelp[Option[T]]]

    Creates a Parser accepting help / usage arguments, out of this one.

    Creates a Parser accepting help / usage arguments, out of this one.

    Definition Classes
    Parser
  50. def withUnderlying(underlying: Aux[T, D0]): OptionParser[T, D0]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Parser[Option[T]]

Inherited from ParserMethods[Option[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped