Package org.aesh.readline.action.mappings

Class Complete

java.lang.Object
org.aesh.readline.action.mappings.Complete
All Implemented Interfaces:
Consumer<InputProcessor>, Action, ActionEvent
public class Complete extends Object implements ActionEvent
Action that triggers tab completion for the current input.
Author:
Ståle W. Pedersen

  • Constructor Summary

    Constructors
    Constructor
    Description
    Complete()
    Creates a new complete action.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(InputProcessor inputProcessor)
    Executes this action on the given input processor.
    void
    input(Action action, org.aesh.terminal.KeyAction key)
    Processes an input event with the given action and key.
    boolean
    keepFocus()
    Returns whether this action event should retain focus after processing.
    String
    name()
    Returns the name of this action.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.function.Consumer

    andThen

  • Constructor Details

    • Complete

      public Complete()
      Creates a new complete action.

  • Method Details

    • name

      public String name()
      Description copied from interface: Action
      Returns the name of this action.
      Specified by:
      name in interface Action
      Returns:
      the action name

    • accept

      public void accept(InputProcessor inputProcessor)
      Description copied from interface: Action
      Executes this action on the given input processor.
      Specified by:
      accept in interface Action
      Specified by:
      accept in interface Consumer<InputProcessor>
      Parameters:
      inputProcessor - the input processor to operate on

    • input

      public void input(Action action, org.aesh.terminal.KeyAction key)
      Description copied from interface: ActionEvent
      Processes an input event with the given action and key.
      Specified by:
      input in interface ActionEvent
      Parameters:
      action - the action that triggered this input
      key - the key action associated with the input

    • keepFocus

      public boolean keepFocus()
      Description copied from interface: ActionEvent
      Returns whether this action event should retain focus after processing.
      Specified by:
      keepFocus in interface ActionEvent
      Returns:
      true if this event should keep focus