Record Class RuleResult

java.lang.Object
java.lang.Record
su.nightexpress.excellentclaims.api.rule.RuleResult
@NullMarked public record RuleResult(EventState state, @Nullable ActionResult feedback) extends Record

  • Constructor Details

    • RuleResult

      public RuleResult(EventState state, @Nullable ActionResult feedback)
      Creates an instance of a RuleResult record class.
      Parameters:
      state - the value for the state record component
      feedback - the value for the feedback record component

  • Method Details

    • of

      public static RuleResult of(boolean result)

    • of

      public static RuleResult of(boolean result, ActionResult feedback)

    • pass

      public static RuleResult pass()

    • allow

      public static RuleResult allow()

    • allow

      public static RuleResult allow(ActionResult feedback)

    • deny

      public static RuleResult deny(ActionResult feedback)

    • deny

      public static RuleResult deny()

    • 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 Objects::equals(Object,Object).
      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.

    • state

      public EventState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • feedback

      public @Nullable ActionResult feedback()
      Returns the value of the feedback record component.
      Returns:
      the value of the feedback record component