Package io.keikai.axyra.sheets.content

Record Class ProtectedRange

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.ProtectedRange
Record Components:
name - the range name (unique within the sheet)
sqref - the space-separated A1 range list
hasPassword - whether a password is stored (kept only as a hash)
public record ProtectedRange(String name, String sqref, boolean hasPassword) extends Record
An allow-users-to-edit-range: a named cell range that stays editable while the sheet is protected, optionally gated by its own password (ECMA-376 Part 1 §18.3.1.72 protectedRange). Read back via Sheet.protectedRanges().

  • Constructor Details

    • ProtectedRange

      public ProtectedRange(String name, String sqref, boolean hasPassword)
      Creates an instance of a ProtectedRange record class.
      Parameters:
      name - the value for the name record component
      sqref - the value for the sqref record component
      hasPassword - the value for the hasPassword 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 '=='.
      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.

    • name

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

    • sqref

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

    • hasPassword

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