abstract class CmdDescriptor extends AnyRef

Base class for all Cmd descriptors (usually companion objects)

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

Instance Constructors

  1. new CmdDescriptor(name: String, cmdParamSyntax: String, description: String)

Abstract Value Members

  1. abstract def parseCmd(ctx: AppContext): Cmd

    Creates a new command instance based on the given AppContext

    Creates a new command instance based on the given AppContext

    Exceptions thrown

    UsageException when the command cannot be parsed or the usage is not correct

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. val BaseDocUrl: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. val cmdParamSyntax: String
  8. val description: String
  9. def docUrl: String

    Url of the ScalaDoc for this command.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def error(msg: String): Nothing

    Called during command line parsing and instantiation of Cmd for execution.

    Called during command line parsing and instantiation of Cmd for execution. This is the prefered method to throw an exception.

  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val name: String
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def parseNetwork(network: String): NetworkType
  22. def printUsage(console: Console): Console

    Outputs the usage help for this command to the given console

  23. def readNewPassword(prompt: String, secondPrompt: String)(implicit ctx: AppContext): Array[Char]
  24. def readNewPassword(nAttemps: Int, console: Console)(block: ⇒ (Array[Char], Array[Char])): Array[Char]

    Secure double entry of the new password giving the user many attempts.

    Secure double entry of the new password giving the user many attempts.

    nAttemps

    number of attempts before failing with exception

    block

    code block which can request the user to enter a new password twice

    returns

    password returned by block as Array[Char] instead of String. This allows the password to be erased as fast as possible and avoid leaking to GC.

    Exceptions thrown
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def usageError(msg: String): Nothing

    Can be used by concrete command descriptors to report usage errors.

    Can be used by concrete command descriptors to report usage errors.

    Attributes
    protected
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped