Record Class PermissionDefinition

java.lang.Object
java.lang.Record
fr.fidorial.permission.PermissionDefinition
public record PermissionDefinition(PermissionNode node, String description, TriState regularDefault, TriState operatorDefault) extends Record

  • Constructor Details

    • PermissionDefinition

      public PermissionDefinition(PermissionNode node, String description, TriState regularDefault, TriState operatorDefault)
      Creates an instance of a PermissionDefinition record class.
      Parameters:
      node - the value for the node record component
      description - the value for the description record component
      regularDefault - the value for the regularDefault record component
      operatorDefault - the value for the operatorDefault record component

  • Method Details

    • operatorOnly

      public static PermissionDefinition operatorOnly(String node, String description)
      Declares a permission only operators hold by default.
      Parameters:
      node - node path
      description - description
      Returns:
      the definition

    • everyone

      public static PermissionDefinition everyone(String node, String description)
      Declares a permission everyone holds by default.
      Parameters:
      node - node path
      description - description
      Returns:
      the definition

    • explicitOnly

      public static PermissionDefinition explicitOnly(String node, String description)
      Declares a permission nobody holds by default, operators included. It has to be granted explicitly through a PermissionGrant or an external PermissionResolver.
      Parameters:
      node - node path
      description - description
      Returns:
      the definition

    • refused

      public static PermissionDefinition refused(String node, String description)
      Declares a permission that is actively refused unless a grant overrides it.
      Parameters:
      node - node path
      description - description
      Returns:
      the definition

    • defaultFor

      public TriState defaultFor(boolean operator)
      Returns the default state for a holder.
      Parameters:
      operator - whether the holder is an operator
      Returns:
      the applicable default

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

    • node

      public PermissionNode node()
      Returns the value of the node record component.
      Returns:
      the value of the node record component

    • description

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

    • regularDefault

      public TriState regularDefault()
      Returns the value of the regularDefault record component.
      Returns:
      the value of the regularDefault record component

    • operatorDefault

      public TriState operatorDefault()
      Returns the value of the operatorDefault record component.
      Returns:
      the value of the operatorDefault record component