Record Class ControlPanelWriteAccess

java.lang.Object
java.lang.Record
io.micronaut.controlpanel.core.security.ControlPanelWriteAccess
Record Components:
allowed - whether write operations are allowed
reason - reason to show when write operations are disabled
@Internal public record ControlPanelWriteAccess(boolean allowed, String reason) extends Record
UI-facing write access state for the current request.

  • Constructor Details

    • ControlPanelWriteAccess

      public ControlPanelWriteAccess(boolean allowed, String reason)
      Creates an instance of a ControlPanelWriteAccess record class.
      Parameters:
      allowed - the value for the allowed record component
      reason - the value for the reason record component

  • Method Details

    • allowedAccess

      public static ControlPanelWriteAccess allowedAccess()
      Returns:
      allowed write access

    • deniedAccess

      public static ControlPanelWriteAccess deniedAccess()
      Returns:
      denied write access with the default UI reason

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

    • allowed

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

    • reason

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