Packages

abstract class Command[T] extends CaseApp[T]

Linear Supertypes
CaseApp[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Command
  2. CaseApp
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Command()(implicit parser: parser.Parser[T], help: help.Help[T])

Abstract Value Members

  1. abstract def run(options: T, remainingArgs: RemainingArgs): Unit
    Definition Classes
    CaseApp

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def complete(args: Seq[String], index: Int): List[CompletionItem]
    Definition Classes
    CaseApp
  7. def completer: Completer[T]
    Definition Classes
    CaseApp
  8. def ensureNoDuplicates(): Unit
    Definition Classes
    CaseApp
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def error(message: Error): Nothing
    Definition Classes
    CaseApp
  12. def exit(code: Int): Nothing
    Definition Classes
    CaseApp
  13. def expandArgs(args: List[String]): List[String]

    Arguments are expanded then parsed.

    Arguments are expanded then parsed. By default, argument expansion is the identity function. Overriding this method allows plugging in an arbitrary argument expansion logic.

    One such expansion logic involves replacing each argument of the form '@<file>' with the contents of that file where each line in the file becomes a distinct argument. To enable this behavior, override this method as shown below.

    Definition Classes
    CaseApp
    Example:

    1. import caseapp.core.parser.PlatformArgsExpander
override def expandArgs(args: List[String]): List[String]
= PlatformArgsExpander.expand(args)
  14. lazy val finalHelp: help.Help[_]
    Definition Classes
    CaseApp
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def fullHelpAsked(progName: String): Nothing
    Definition Classes
    CaseApp
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def group: String
  19. def hasFullHelp: Boolean
    Definition Classes
    CaseApp
  20. def hasHelp: Boolean
    Definition Classes
    CaseApp
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def helpAsked(progName: String, maybeOptions: Either[Error, T]): Nothing
    Definition Classes
    CaseApp
  23. def helpFormat: HelpFormat
    Definition Classes
    CaseApp
  24. def hidden: Boolean
  25. def ignoreUnrecognized: Boolean

    Whether to ignore unrecognized arguments.

    Whether to ignore unrecognized arguments.

    That is, if there are unrecognized arguments, the parsing still succeeds. The unparsed arguments are put in the args argument of run.

    Definition Classes
    CaseApp
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def main(progName: String, args: Array[String]): Unit
    Definition Classes
    CaseApp
  28. def main(args: Array[String]): Unit
    Definition Classes
    CaseApp
  29. implicit val messages: help.Help[T]
    Definition Classes
    CaseApp
  30. def name: String
  31. def nameFormatter: Formatter[Name]
    Definition Classes
    CaseApp
  32. def names: List[List[String]]
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. def parser: parser.Parser[T]
    Definition Classes
    CaseApp
  37. implicit val parser0: parser.Parser[T]
    Definition Classes
    CaseApp
  38. def stopAtFirstUnrecognized: Boolean

    Whether to stop parsing at the first unrecognized argument.

    Whether to stop parsing at the first unrecognized argument.

    That is, stop parsing at the first non option (not starting with "-"), or the first unrecognized option. The unparsed arguments are put in the args argument of run.

    Definition Classes
    CaseApp
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. def usageAsked(progName: String, maybeOptions: Either[Error, T]): Nothing
    Definition Classes
    CaseApp
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from CaseApp[T]

Inherited from AnyRef

Inherited from Any

Ungrouped