Package io.keikai.axyra.sheets.content

Record Class WriteProtection

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.WriteProtection
Record Components:
readOnlyRecommended - whether Excel prompts to open read-only
userName - who reserved the workbook, or null
hasPassword - whether a modify password is stored (the password itself is only kept as a hash)
public record WriteProtection(boolean readOnlyRecommended, String userName, boolean hasPassword) extends Record
The workbook's write-protection state (<fileSharing> — ECMA-376 Part 1 §18.2.12), read back via Workbook.writeProtection().

  • Constructor Details

    • WriteProtection

      public WriteProtection(boolean readOnlyRecommended, String userName, boolean hasPassword)
      Creates an instance of a WriteProtection record class.
      Parameters:
      readOnlyRecommended - the value for the readOnlyRecommended record component
      userName - the value for the userName 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.

    • readOnlyRecommended

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

    • userName

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

    • hasPassword

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