CandidateCycleCompletionHandler
Date: 2015-12-09

jline

## Class CandidateCycleCompletionHandler

- java.lang.Object
- - jline.CandidateCycleCompletionHandler

- All Implemented Interfaces:
    CompletionHandler

      public class CandidateCycleCompletionHandler
      extends java.lang.Object
      implements CompletionHandler

  A `CompletionHandler` that deals with multiple distinct completions by cycling through each one every time tab is pressed. This mimics the behavior of the editline library.

  This class is currently a stub; it does nothing

  Author:
    Marc Prud'hommeaux

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `CandidateCycleCompletionHandler()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `complete(ConsoleReader reader, java.util.List candidates, int position)`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### CandidateCycleCompletionHandler

          public CandidateCycleCompletionHandler()

  - ### Method Detail

    - #### complete

          public boolean complete(ConsoleReader reader,
                         java.util.List candidates,
                         int position)
                           throws java.io.IOException

      Specified by:
        `complete` in interface `CompletionHandler`
      Throws:
        `java.io.IOException`