abstract class Command[T] extends CaseApp[T]
- Alphabetic
- By Inheritance
- Command
- CaseApp
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Command()(implicit parser: parser.Parser[T], help: help.Help[T])
Abstract Value Members
- abstract def run(options: T, remainingArgs: RemainingArgs): Unit
- Definition Classes
- CaseApp
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def complete(args: Seq[String], index: Int): List[CompletionItem]
- Definition Classes
- CaseApp
- def completer: Completer[T]
- Definition Classes
- CaseApp
- def ensureNoDuplicates(): Unit
- Definition Classes
- CaseApp
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def error(message: Error): Nothing
- Definition Classes
- CaseApp
- def exit(code: Int): Nothing
- Definition Classes
- CaseApp
- 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
import caseapp.core.parser.PlatformArgsExpander override def expandArgs(args: List[String]): List[String] = PlatformArgsExpander.expand(args)
Example: - lazy val finalHelp: help.Help[_]
- Definition Classes
- CaseApp
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def fullHelpAsked(progName: String): Nothing
- Definition Classes
- CaseApp
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def group: String
- def hasFullHelp: Boolean
- Definition Classes
- CaseApp
- def hasHelp: Boolean
- Definition Classes
- CaseApp
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def helpAsked(progName: String, maybeOptions: Either[Error, T]): Nothing
- Definition Classes
- CaseApp
- def helpFormat: HelpFormat
- Definition Classes
- CaseApp
- def hidden: Boolean
- 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 ofrun
.- Definition Classes
- CaseApp
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def main(progName: String, args: Array[String]): Unit
- Definition Classes
- CaseApp
- def main(args: Array[String]): Unit
- Definition Classes
- CaseApp
- implicit val messages: help.Help[T]
- Definition Classes
- CaseApp
- def name: String
- def nameFormatter: Formatter[Name]
- Definition Classes
- CaseApp
- def names: List[List[String]]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parser: parser.Parser[T]
- Definition Classes
- CaseApp
- implicit val parser0: parser.Parser[T]
- Definition Classes
- CaseApp
- 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 ofrun
.- Definition Classes
- CaseApp
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def usageAsked(progName: String, maybeOptions: Either[Error, T]): Nothing
- Definition Classes
- CaseApp
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()