Package org.apache.poi.hssf.record

Class FileSharingRecord

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.FileSharingRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class FileSharingRecord extends StandardRecord
Stores the encrypted readonly for a workbook (write protect).

This functionality is accessed from the options dialog box available when performing 'Save As'.

  • Field Details

  • Constructor Details

    • FileSharingRecord

      public FileSharingRecord()

    • FileSharingRecord

      public FileSharingRecord(FileSharingRecord other)

    • FileSharingRecord

      public FileSharingRecord(RecordInputStream in)

  • Method Details

    • setReadOnly

      public void setReadOnly(short readonly)
      set the readonly flag
      Parameters:
      readonly - 1 for true, not 1 for false

    • getReadOnly

      public short getReadOnly()
      get the readonly
      Returns:
      short representing if this is read only (1 = true)

    • setPassword

      public void setPassword(short password)
      Parameters:
      password - hashed password

    • getPassword

      public short getPassword()
      Returns:
      password hashed with hashPassword() (very lame)

    • getUsername

      public String getUsername()
      Returns:
      username of the user that created the file

    • setUsername

      public void setUsername(String username)
      Parameters:
      username - of the user that created the file

    • serialize

      public void serialize(LittleEndianOutput out)

    • getSid

      public short getSid()
      Description copied from class: Record
      return the non static version of the id for this record.
      Specified by:
      getSid in class Record
      Returns:
      he id for this record

    • copy

      public FileSharingRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()