Class

com.sumologic.shellbase

ShellCommand

Related Doc: package shellbase

Permalink

abstract class ShellCommand extends AnyRef

Definition of a shell command.

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

Instance Constructors

  1. new ShellCommand(name: String, helpText: String, aliases: List[String] = List[String](), deprecated: Boolean = false, hiddenInHelp: Boolean = false, usageText: Option[String] = None)(implicit e: ExecutionContext = ...)

    Permalink

Abstract Value Members

  1. abstract def execute(cmdLine: CommandLine): Boolean

    Permalink

    Execute the command.

    Execute the command. The command line passed in contains everything the user specified - options and other arguments. Returns true if the command succeeded, false otherwise.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val _logger: Logger

    Permalink
    Attributes
    protected
  5. def addOptions(opts: Options): Unit

    Permalink
  6. val aliases: List[String]

    Permalink
  7. def argCompleter: Completer

    Permalink

    Returns a completer that jline can use for tab completion.

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def basicVariants: List[String]

    Permalink
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def completer: NestedCompleter

    Permalink
  12. def currentCommand: String

    Permalink
    Attributes
    protected
  13. val deprecated: Boolean

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def executeLine(argumentsInput: List[String], commandPath: List[String] = List()): Boolean

    Permalink
  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def help: Unit

    Permalink
  21. val helpText: String

    Permalink
  22. val hiddenInHelp: Boolean

    Permalink
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def maxNumberOfArguments: Int

    Permalink
  25. val name: String

    Permalink
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def parseOptions(arguments: Seq[String]): CommandLine

    Permalink
  30. def postCommandToSlack(cmdPath: List[String], args: List[String], comments: Option[String]): Option[String]

    Permalink
  31. def postInformationToSlackThread(ts: String, commandExecuteTimeDuration: Long, commandResult: Boolean): Option[String]

    Permalink
  32. lazy val prompter: ShellPrompter

    Permalink
    Attributes
    protected
  33. def shouldRunNotifications(arguments: List[String], commandPath: List[String] = List()): Boolean

    Permalink

    Returns true iff notifications should be run for this command

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

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. val usageText: Option[String]

    Permalink
  37. def validate(cmdLine: CommandLine): Option[String]

    Permalink
  38. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped