grizzled.cmd

HiddenCommandHandler

trait HiddenCommandHandler extends NoCompletionsHandler

The handler trait for a hidden command. Hidden commands don't show up in the help or the history.

linear super types: NoCompletionsHandler, CommandHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. HiddenCommandHandler
  2. NoCompletionsHandler
  3. CommandHandler
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. val CommandName : String

    The name of the command.

    The name of the command. This name, or any of the aliases (see below) will cause the command to be invoked.

    attributes: abstract
    definition classes: CommandHandler
  9. val Help : String

    The help for this command.

    The help for this command. The help string is written as is to the screen. It is not wrapped, indented, or otherwise reformatted. It may be a single string or a multiline string.

    definition classes: HiddenCommandHandlerCommandHandler
  10. val aliases : List[String]

    Additional aliases for the command, if any.

    Additional aliases for the command, if any.

    definition classes: CommandHandler
  11. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  12. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  13. def commandNameCompletions (prefix: String) : List[String]

    Compares a prefix string to this command name and its aliases, to determine whether the prefix string could possibly be completed by the name or aliases.

    Compares a prefix string to this command name and its aliases, to determine whether the prefix string could possibly be completed by the name or aliases. This method is obviously used to facilitate tab-completion. The default implementation of this method simply forces both strings to lower case before performing a substring comparison between them. Overridden definitions of this method can apply other matching criteria.

    prefix

    the prefix to compare

    returns

    a list of the strings (name and/or aliases) that could be completed by prefix, or Nil.

    attributes: final
    definition classes: NoCompletionsHandlerCommandHandler
  14. def complete (token: String, context: List[CompletionToken], commandLine: String) : List[String]

    Perform completion on the command, returning the possible completions.

    Perform completion on the command, returning the possible completions. This method has the exact same interface and use as thecomplete() method in grizzled.readline.Completer. Please see that trait for full documentation.

    token

    the token being completed

    context

    the token context (i.e., list of parsed tokens, with cursor)

    definition classes: CommandHandler
  15. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  18. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  19. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  20. val hidden : Boolean

    Whether or not the command is hidden.

    Whether or not the command is hidden. Hidden commands don't show up in the help list or the history. Using the HiddenCommandHandlertrait saves a lot of work.

    definition classes: HiddenCommandHandlerCommandHandler
  21. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  22. def matches (candidate: String) : Boolean

    Compares a command name (that the user typed in, for instance) to this command's name.

    Compares a command name (that the user typed in, for instance) to this command's name. The default implementation of this method simply forces both names to lower case before comparing them. Overridden definitions of this method can apply other matching criteria.

    candidate

    the candidate name to be compared with this one

    returns

    true if they match, false if not

    definition classes: CommandHandler
  23. def moreInputNeeded (lineSoFar: String) : Boolean

    This method is called after a line is read that matches this command, to determine whether more lines need to be read to finish the command.

    This method is called after a line is read that matches this command, to determine whether more lines need to be read to finish the command. The default implementation returns false, meaning a single input line suffices for the entire command. Implementing classes or objects can override this method to ensure that the command has a required terminating character (e.g., a ";"), doesn't end with a line continuation character (e.g., "\"), or whatever the syntax requires.

    lineSoFar

    the line read so far

    definition classes: CommandHandler
  24. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  25. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  26. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  27. def runCommand (command: String, unparsedArgs: String) : CommandAction

    Handle the command.

    Handle the command. The first white space-delimited token in the command string is guaranteed to match the name of this command, by the rules of the matches() method.

    command

    the command that invoked this handler

    unparsedArgs

    the remainder of the unparsed command line

    returns

    KeepGoing to tell the main loop to continue, or Stop to tell the main loop to be done.

    attributes: abstract
    definition classes: CommandHandler
  28. val storeInHistory : Boolean

    Whether or not the command should be put in the history.

    Whether or not the command should be put in the history.

    definition classes: HiddenCommandHandlerCommandHandler
  29. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  30. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  31. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  32. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  33. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from NoCompletionsHandler

Inherited from CommandHandler

Inherited from AnyRef

Inherited from Any