Module org.snapfx
Package org.snapfx.close

Record Class DockCloseResult

java.lang.Object
java.lang.Record
org.snapfx.close.DockCloseResult
Record Components:
request - original request context
appliedBehavior - resolved behavior that was applied; null when canceled
canceled - whether the request was canceled
public record DockCloseResult(DockCloseRequest request, DockCloseBehavior appliedBehavior, boolean canceled) extends Record
Describes the outcome of a processed close request.

  • Constructor Details

    • DockCloseResult

      public DockCloseResult(DockCloseRequest request, DockCloseBehavior appliedBehavior, boolean canceled)
      Creates an instance of a DockCloseResult record class.
      Parameters:
      request - the value for the request record component
      appliedBehavior - the value for the appliedBehavior record component
      canceled - the value for the canceled 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.

    • request

      public DockCloseRequest request()
      Returns the value of the request record component.
      Returns:
      the value of the request record component

    • appliedBehavior

      public DockCloseBehavior appliedBehavior()
      Returns the value of the appliedBehavior record component.
      Returns:
      the value of the appliedBehavior record component

    • canceled

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