ListCompleter

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 complete(token: String, context: List[CompletionToken], line: String): List[String]

   

   Get all completions for a token.

   Get all completions for a token. The context argument bears some explaining. It's designed to allow the completer to locate the cursor (and the nearest token) via Scala pattern matching, and it consists of a stream of abstract tokens:

   - LineToken is a token parsed from the line, in an object that's similar to Some: LineToken.value returns the token's string. - Cursor indicates the location of the cursor - Delim indicates the presence of a token delimiter (typically white space)

   The input line is broken into these tokens, which can then be matched. For example, consider the following input lines, with the cursor where the caret is:

   Line: ^ (empty) Tokens: Cursor

   Line: cm^ Tokens: LineToken("cm") Cursor

   Line: cmd ^ Tokens: LineToken("cmd") Delim Cursor Line: `cmd arg1^` Tokens: `LineToken("cmd") Delim Token("arg1") Cursor` Line: `cmd arg1^` Tokens: `LineToken("cmd") Delim Token("arg1") Delim Cursor` Line: `cmd^ arg1` Tokens: `LineToken("cmd") Cursor Delim Token("arg1")` Line: `cm^d arg1` Tokens: `LineToken("cmd") Cursor Delim Token("arg1")`

   token

   the token being completed

   line

   the current unparsed input line, which includes the token

   returns

   a list of completions, or Nil if there are no matches

   Definition Classes

   ListCompleter → Completer

7. val completions: List[String]

   

   the list of valid completions

8. val convert: (String) ⇒ String

   

   function to convert both the token to be compared and the candidate completion token, before comparing them (e.g., by converting them to lower case)

9. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

13. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

14. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

15. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

16. final def notify(): Unit

    

    Definition Classes

    AnyRef

17. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

19. def toString(): String

    

    Definition Classes

    AnyRef → Any

20. def tokenDelimiters: String

    

    Get the delimiters that should be used to break a line into tokens.

    Get the delimiters that should be used to break a line into tokens. The default is white space.

    returns

    the delimiters

    Definition Classes

    Completer

21. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

22. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

23. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )