Packages

trait SubCommand extends AnyRef

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.

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

Abstract Value Members

  1. abstract def execute(args: List[String], 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

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(): Optional[String]

    Returns an Optional containing a brief description of this sub-command, or an empty Optional if no description is provided.

    Returns an Optional containing a brief description of this sub-command, or an empty Optional if no description is provided.

    returns

    a brief description of this sub-command

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. def help(args: List[String]): Optional[String]

    Returns an Optional containing a help message for this sub-command, or an empty Optional if no help message is provided.

    Returns an Optional containing a help message for this sub-command, or an empty Optional 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

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def tabComplete(args: List[String]): List[String]

    Returns a list of suggested completions for the final argument of a list of arguments.

    Returns a list of suggested completions for the final argument of a list of arguments. Returns an empty list if no suggestions are available for a given argument list.

    args

    the arguments for which to provide suggested completions

    returns

    a list of suggested completions for the final argument given

  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped