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

Record Class KeyHandler.KeyHandlerResult

java.lang.Object
java.lang.Record
org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
Record Components:
event - the Key event
consumed - flag telling if event was consumed
focus - the view which consumed an event
capture - the view which captured an event
Enclosing interface:
KeyHandler
public static record KeyHandler.KeyHandlerResult(KeyEvent event, boolean consumed, View focus, View capture) extends Record
Result from a KeyHandler.

  • Constructor Details

    • KeyHandlerResult

      public KeyHandlerResult(@Nullable KeyEvent event, boolean consumed, @Nullable View focus, @Nullable View capture)
      Creates an instance of a KeyHandlerResult record class.
      Parameters:
      event - the value for the event record component
      consumed - the value for the consumed record component
      focus - the value for the focus record component
      capture - the value for the capture record component

  • Method Details

    • 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.

    • event

      @Nullable public KeyEvent event()
      Returns the value of the event record component.
      Returns:
      the value of the event record component

    • consumed

      public boolean consumed()
      Returns the value of the consumed record component.
      Returns:
      the value of the consumed record component

    • focus

      @Nullable public View focus()
      Returns the value of the focus record component.
      Returns:
      the value of the focus record component

    • capture

      @Nullable public View capture()
      Returns the value of the capture record component.
      Returns:
      the value of the capture record component