Record Class IProtectionHookManager.HookCheckResult

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.core.api.IProtectionHookManager.HookCheckResult
Record Components:
isDenied - True if the check was denied.
denyingHookName - The name of the hook that denied the check, or null if no name is available (e.g. when the check was allowed, or when multiple hooks denied the check).
Enclosing interface:
IProtectionHookManager
public static record IProtectionHookManager.HookCheckResult(boolean isDenied, @Nullable String denyingHookName) extends Record
Represents the result of a protection hook check.

  • Field Details

  • Constructor Details

    • HookCheckResult

      public HookCheckResult(boolean isDenied, @Nullable String denyingHookName)
      Creates an instance of a HookCheckResult record class.
      Parameters:
      isDenied - the value for the isDenied record component
      denyingHookName - the value for the denyingHookName record component

  • Method Details

    • isAllowed

      public boolean isAllowed()
      Check if the check was allowed.
      Returns:
      True if the check was allowed.

    • allowed

      public static IProtectionHookManager.HookCheckResult allowed()
      Create a new CheckResult that indicates that the check was allowed.
      Returns:
      The new CheckResult.

    • denied

      public static IProtectionHookManager.HookCheckResult denied(@Nullable String denyingHookName)
      Create a new CheckResult that indicates that the check was denied.
      Parameters:
      denyingHookName - The name of the hook that denied the check.
      Returns:
      The new CheckResult.

    • denied

      public static IProtectionHookManager.HookCheckResult denied()
      Create a new CheckResult that indicates that the check was denied.

      This method should be used when the denying hook name is not available.

      If the denying hook name is available, use denied(String) instead.

      Returns:
      The new CheckResult.

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

    • isDenied

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

    • denyingHookName

      public @Nullable String denyingHookName()
      Returns the value of the denyingHookName record component.
      Returns:
      the value of the denyingHookName record component