Package org.springframework.shell.component.view.event

Record Class KeyEvent

java.lang.Object
java.lang.Record
org.springframework.shell.component.view.event.KeyEvent
public record KeyEvent(int key, String data) extends Record
mask special keys unicode keys ascii keys [ ] [ ] [ ] [ ] 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    KeyEvent.Key
     
    static class 
    KeyEvent.KeyMask
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyEvent(int key, String data)
    Creates an instance of a KeyEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    data()
    Returns the value of the data record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    getPlainKey()
     
    boolean
    hasCtrl()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isKey()
     
    boolean
    isKey(int match)
     
    int
    key()
    Returns the value of the key record component.
    static KeyEvent
    of(int key)
     
    static KeyEvent
    of(String raw)
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • KeyEvent

      public KeyEvent(int key, String data)
      Creates an instance of a KeyEvent record class.
      Parameters:
      key - the value for the key record component
      data - the value for the data record component

  • Method Details

    • of

      public static KeyEvent of(int key)

    • of

      public static KeyEvent of(String raw)

    • hasCtrl

      public boolean hasCtrl()

    • getPlainKey

      public int getPlainKey()

    • isKey

      public boolean isKey(int match)

    • isKey

      public boolean isKey()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public int key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • data

      public String data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component