io.mth.pirate

Commands

sealed trait Commands[A] extends AnyRef

Commands data type. Represents a command with sub-commands.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Commands
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def fold[X](x: (String, Option[String], List[SubCommand[A]]) ⇒ X): X

    Catamorphism for Command data type.

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

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def description: Option[String]

    The description of this command.

  7. def dispatch(args: List[String])(success: (A) ⇒ Unit)(error: (String) ⇒ Unit): Int

    Higher order function to handle parse and dispatch.

    Higher order function to handle parse and dispatch. This is a convenience only.

  8. def dispatchOrDie(args: List[String], err: PrintStream = System.err)(f: (A) ⇒ Unit): Unit

    Higher order function to handle parse and dispatch.

    Higher order function to handle parse and dispatch. This is a convenience only.

  9. def dispatchOrUsage(args: List[String], err: PrintStream = System.err)(f: (A) ⇒ Unit): Int

    Higher order function to handle parse and dispatch.

    Higher order function to handle parse and dispatch. This is a convenience only.

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

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

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

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

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

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

    Definition Classes
    Any
  16. def name: String

    The name of this command.

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

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. def parse(args: List[String]): Validation[String, A]

    Parse a list of arguments based on this command and apply the resultant function to the data object.

  21. def subcommands: List[SubCommand[A]]

    The subcommands of this command.

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

    Definition Classes
    AnyRef
  23. def toParser: Parser[A]

    Create an argument parser for this command.

    Create an argument parser for this command. This is for advanced usage only. It is expected that the parse method is sufficient for most cases.

  24. def toString(): String

    Definition Classes
    AnyRef → Any
  25. def usage: String

    The usage string for this command using the default usage mode.

    The usage string for this command using the default usage mode. Equivalent to usageForMode(DefaultUsageMode).

  26. def usageForMode(mode: UsageMode): String

    The usage string for this command using the specified usage mode.

  27. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def withSubCommand[B](seed: B, command: Command[B], unifier: (B) ⇒ A): Commands[A]

  31. def withSubtypeCommand[B <: A](seed: B, command: Command[B]): Commands[A]

  32. def ~(description: String): Commands[A]

    Combine this command with the specified description and return the new description.

    Combine this command with the specified description and return the new description. If a description is already set it shall be replaced.

Inherited from AnyRef

Inherited from Any

Ungrouped