Record Class ActionData

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.core.nonentities.action.ActionData
Record Components:
success - true if action succeeded
data - any object
logs - logging information
public record ActionData(boolean success, Object data, String logs) extends Record
Record storing the result of a durable action handler, including any return data as well as log information.
Version:
3.0.6
Author:
Stephen Prizio

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionData(boolean success, Object data, String logs)
    Creates an instance of a ActionData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    data()
    Returns the value of the data record component.
    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.
    String
    logs()
    Returns the value of the logs record component.
    boolean
    success()
    Returns the value of the success record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ActionData

      public ActionData(boolean success, Object data, String logs)
      Creates an instance of a ActionData record class.
      Parameters:
      success - the value for the success record component
      data - the value for the data record component
      logs - the value for the logs 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 the compare method from their corresponding wrapper classes.
      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.

    • success

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

    • data

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

    • logs

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