trait SubCommand extends Executable with TabCompletable
A sub-command to be executed by a Shell. It may be a top-level command, a sub-command of a top-level command, or a sub-command of another sub-command.
- Alphabetic
- By Inheritance
- SubCommand
- TabCompletable
- Executable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
execute(args: ImmutableSeq[String])(implicit sink: OutputSink): Unit
Executes this sub-command with the given arguments.
Executes this sub-command with the given arguments.
- args
the arguments with which this should be executed
- sink
an OutputSink to which output may be written during execution
- Definition Classes
- SubCommand → Executable
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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
description: Option[String]
Returns an Option containing a brief description of this sub-command, or None if no description is provided.
Returns an Option containing a brief description of this sub-command, or None if no description is provided.
- returns
a brief description of this sub-command
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
def
help(args: ImmutableSeq[String]): Option[String]
Returns an Option containing a help message for this sub-command, or None if no help message is provided.
Returns an Option containing a help message for this sub-command, or None if no help message is provided.
The message may be based on the arguments provided, or it may be a static message regardless of the arguments provided. For example, it may return a different message for different sub-command of its own.
- args
the arguments of this command for which to get a help message
- returns
a help message for this sub-command with the given arguments
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tabComplete(args: ImmutableSeq[String]): ImmutableSeq[String]
Returns a sequence of suggested completions for the final argument of a sequence of arguments.
Returns a sequence of suggested completions for the final argument of a sequence of arguments. Returns an empty sequence if no suggestions are available for a given argument sequence.
- args
the arguments for which to provide suggested completions
- returns
a sequence of suggested completions for the final argument given
- Definition Classes
- SubCommand → TabCompletable
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )