Module technology.sola.engine
Package technology.sola.engine.input

Record Class KeyEvent

java.lang.Object
java.lang.Record
technology.sola.engine.input.KeyEvent
Record Components:
keyCode - the ASCII code of the key for the event
@NullMarked public record KeyEvent(int keyCode) extends Record
KeyEvent contains data for a keyboard-related event.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyEvent(int keyCode)
    Creates an instance of a KeyEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    char
    keyChar()
     
    int
    keyCode()
    Returns the value of the keyCode record component.
    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 keyCode)
      Creates an instance of a KeyEvent record class.
      Parameters:
      keyCode - the value for the keyCode record component

  • Method Details

    • keyChar

      public char keyChar()
      Returns:
      the character associated with the key code

    • 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. All components in this record class 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.

    • keyCode

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