SimpleCompletor (groovy 2.4.3 API)
Date: 2015-03-23

Package: org.codehaus.groovy.tools.shell.util

## [Groovy] Class SimpleCompletor

- org.codehaus.groovy.tools.shell.util.SimpleCompletor

- All Implemented Interfaces and Traits:
    Completer

      class SimpleCompletor

  Support for simple completors.

  Authors:
    Jason Dillon
  Version:
    \$Id\$

- - ### Properties Summary

    Properties
    Type | Name and description
    --- | ---
    `SortedSet<String>` | `candidates`
    `String` | `delimiter` A delimiter to use to qualify completions.

  - ### Constructor Summary

    Constructors
    Constructor and description
    `SimpleCompletor (String[] candidates)`
    `SimpleCompletor ()`
    `SimpleCompletor (Closure loader)`

  - ### Methods Summary

    Methods
    Type | Name and description
    --- | ---
    `void` | `add(String candidate)`
    `void` | `addCandidateString(String string)`
    `int` | `complete(String buffer, int cursor, List<CharSequence> clist)`
    `SortedSet<String>` | `getCandidates()`
    `Object` | `leftShift(String s)`
    `void` | `setCandidateStrings(String[] strings)`
    `void` | `setCandidates(SortedSet<String> candidates)`

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Property Detail

    - #### SortedSet<String> candidates

    - #### String delimiter

      A delimiter to use to qualify completions.

  - ### Constructor Detail

    - #### SimpleCompletor(String[] candidates)

    - #### SimpleCompletor()

    - #### SimpleCompletor(Closure loader)

  - ### Method Detail

    - #### void add(String candidate)

    - #### void addCandidateString(String string)

    - #### @Override int complete(String buffer, int cursor, List<CharSequence> clist)

    - #### SortedSet<String> getCandidates()

    - #### Object leftShift(String s)

    - #### void setCandidateStrings(String[] strings)

    - #### void setCandidates(SortedSet<String> candidates)