Package org.aesh.terminal

Interface KeyAction

All Known Implementing Classes:
Key
public interface KeyAction
Represents a key value.

  • Method Summary

    Modifier and Type
    Method
    Description
    default IntBuffer
    buffer()
    Get the key values as an IntBuffer.
    default boolean
    bufferEquals(KeyAction otherAction)
    Check if this key action equals another based on buffer contents.
    int
    getCodePointAt(int index)
    Get the code point at the specified index.
    int
    length()
    Get the number of code points in this key action.
    String
    name()
    Get the name of this key action.

  • Method Details

    • buffer

      default IntBuffer buffer()
      Get the key values as an IntBuffer.
      Returns:
      the key values as an IntBuffer

    • getCodePointAt

      int getCodePointAt(int index) throws IndexOutOfBoundsException
      Get the code point at the specified index.
      Parameters:
      index - the index of the code point
      Returns:
      the code point at the given index
      Throws:
      IndexOutOfBoundsException - if the index is out of range

    • length

      int length()
      Get the number of code points in this key action.
      Returns:
      the length

    • name

      String name()
      Get the name of this key action.
      Returns:
      the name

    • bufferEquals

      default boolean bufferEquals(KeyAction otherAction)
      Check if this key action equals another based on buffer contents.
      Parameters:
      otherAction - the other key action to compare
      Returns:
      true if the buffers are equal