caseapp.core.commandparser

CommandParser

abstract class CommandParser[T] extends AnyRef

Parses arguments, handling sub-commands.

Linear Supertypes
AnyRef, Any
Known Subclasses
ConsCommandParser, MappedCommandParser, NilCommandParser, WithHelpCommandParser
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommandParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CommandParser()

Abstract Value Members

  1. abstract def get(command: String): Option[parser.Parser[T]]

    Check if this caseapp.core.commandparser.CommandParser accepts a command, and return its caseapp.core.parser.Parser if it does.

    Check if this caseapp.core.commandparser.CommandParser accepts a command, and return its caseapp.core.parser.Parser if it does.

    returns

    in case of success, Parser[T] of command, wrapped in scala.Some; scala.None in case of failure

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. final def detailedParse[D](args: Seq[String])(implicit beforeCommandParser: parser.Parser[D]): Either[Error, (D, Seq[String], Option[Either[Error, (String, T, RemainingArgs)]])]

    Parse arguments.

    Parse arguments.

    Like parse, but keeps the non option arguments in a caseapp.core.RemainingArgs.

    returns

    in case of error, an caseapp.core.Error, wrapped in scala.Left; in case of success, a D, the non option arguments, wrapped in a scala.Right, along with the result of parsing the specified command if any.

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

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final def map[U](f: (T) ⇒ U): CommandParser[U]

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

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  19. final def parse[D](args: Seq[String])(implicit beforeCommandParser: parser.Parser[D]): Either[Error, (D, Seq[String], Option[Either[Error, (String, T, Seq[String])]])]

    Parse arguments.

    Parse arguments.

    Arguments before any command are parsed with beforeCommandParser as a D.

    returns

    in case of error, an caseapp.core.Error, wrapped in scala.Left; in case of success, a D, the non option arguments, wrapped in a scala.Right, along with the result of parsing the specified command if any.

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

    Definition Classes
    AnyRef

  21. def toString(): String

    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def withHelp: CommandParser[WithHelp[T]]

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

Inherited from AnyRef

Inherited from Any

Ungrouped