Class/Object

caseapp.core.commandparser

CommandParser

Related Docs: object CommandParser | package commandparser

Permalink

abstract class CommandParser[T] extends AnyRef

Parses arguments, handling sub-commands.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommandParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CommandParser()

    Permalink

Abstract Value Members

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

    Permalink

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def detailedParse[D](args: Seq[String])(implicit beforeCommandParser: parser.Parser[D]): Either[Error, (D, Seq[String], Option[Either[Error, (String, T, RemainingArgs)]])]

    Permalink

    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.

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def map[U](f: (T) ⇒ U): CommandParser[U]

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

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

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

    Permalink
    Definition Classes
    AnyRef
  17. final def parse[D](args: Seq[String])(implicit beforeCommandParser: parser.Parser[D]): Either[Error, (D, Seq[String], Option[Either[Error, (String, T, Seq[String])]])]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def withHelp: CommandParser[WithHelp[T]]

    Permalink

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

Inherited from AnyRef

Inherited from Any

Ungrouped