Package org.xlsx4j.sml

Class CTWorkbookProtection

java.lang.Object
org.xlsx4j.sml.CTWorkbookProtection
All Implemented Interfaces:
Child
public class CTWorkbookProtection extends Object implements Child

Java class for CT_WorkbookProtection complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CT_WorkbookProtection">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="workbookPassword" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_UnsignedShortHex" />
       <attribute name="workbookPasswordCharacterSet" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="revisionsPassword" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_UnsignedShortHex" />
       <attribute name="revisionsPasswordCharacterSet" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="lockStructure" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="lockWindows" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="lockRevision" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="revisionsAlgorithmName" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="revisionsHashValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="revisionsSaltValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="revisionsSpinCount" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="workbookAlgorithmName" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="workbookHashValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="workbookSaltValue" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
       <attribute name="workbookSpinCount" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • workbookPassword

      protected byte[] workbookPassword

    • workbookPasswordCharacterSet

      protected String workbookPasswordCharacterSet

    • revisionsPassword

      protected byte[] revisionsPassword

    • revisionsPasswordCharacterSet

      protected String revisionsPasswordCharacterSet

    • lockStructure

      protected Boolean lockStructure

    • lockWindows

      protected Boolean lockWindows

    • lockRevision

      protected Boolean lockRevision

    • revisionsAlgorithmName

      protected String revisionsAlgorithmName

    • revisionsHashValue

      protected byte[] revisionsHashValue

    • revisionsSaltValue

      protected byte[] revisionsSaltValue

    • revisionsSpinCount

      protected Long revisionsSpinCount

    • workbookAlgorithmName

      protected String workbookAlgorithmName

    • workbookHashValue

      protected byte[] workbookHashValue

    • workbookSaltValue

      protected byte[] workbookSaltValue

    • workbookSpinCount

      protected Long workbookSpinCount

  • Constructor Details

    • CTWorkbookProtection

      public CTWorkbookProtection()

  • Method Details

    • getWorkbookPassword

      public byte[] getWorkbookPassword()
      Gets the value of the workbookPassword property.
      Returns:
      possible object is String

    • setWorkbookPassword

      public void setWorkbookPassword(byte[] value)
      Sets the value of the workbookPassword property.
      Parameters:
      value - allowed object is String

    • getWorkbookPasswordCharacterSet

      public String getWorkbookPasswordCharacterSet()
      Gets the value of the workbookPasswordCharacterSet property.
      Returns:
      possible object is String

    • setWorkbookPasswordCharacterSet

      public void setWorkbookPasswordCharacterSet(String value)
      Sets the value of the workbookPasswordCharacterSet property.
      Parameters:
      value - allowed object is String

    • getRevisionsPassword

      public byte[] getRevisionsPassword()
      Gets the value of the revisionsPassword property.
      Returns:
      possible object is String

    • setRevisionsPassword

      public void setRevisionsPassword(byte[] value)
      Sets the value of the revisionsPassword property.
      Parameters:
      value - allowed object is String

    • getRevisionsPasswordCharacterSet

      public String getRevisionsPasswordCharacterSet()
      Gets the value of the revisionsPasswordCharacterSet property.
      Returns:
      possible object is String

    • setRevisionsPasswordCharacterSet

      public void setRevisionsPasswordCharacterSet(String value)
      Sets the value of the revisionsPasswordCharacterSet property.
      Parameters:
      value - allowed object is String

    • isLockStructure

      public boolean isLockStructure()
      Gets the value of the lockStructure property.
      Returns:
      possible object is Boolean

    • setLockStructure

      public void setLockStructure(Boolean value)
      Sets the value of the lockStructure property.
      Parameters:
      value - allowed object is Boolean

    • isLockWindows

      public boolean isLockWindows()
      Gets the value of the lockWindows property.
      Returns:
      possible object is Boolean

    • setLockWindows

      public void setLockWindows(Boolean value)
      Sets the value of the lockWindows property.
      Parameters:
      value - allowed object is Boolean

    • isLockRevision

      public boolean isLockRevision()
      Gets the value of the lockRevision property.
      Returns:
      possible object is Boolean

    • setLockRevision

      public void setLockRevision(Boolean value)
      Sets the value of the lockRevision property.
      Parameters:
      value - allowed object is Boolean

    • getRevisionsAlgorithmName

      public String getRevisionsAlgorithmName()
      Gets the value of the revisionsAlgorithmName property.
      Returns:
      possible object is String

    • setRevisionsAlgorithmName

      public void setRevisionsAlgorithmName(String value)
      Sets the value of the revisionsAlgorithmName property.
      Parameters:
      value - allowed object is String

    • getRevisionsHashValue

      public byte[] getRevisionsHashValue()
      Gets the value of the revisionsHashValue property.
      Returns:
      possible object is byte[]

    • setRevisionsHashValue

      public void setRevisionsHashValue(byte[] value)
      Sets the value of the revisionsHashValue property.
      Parameters:
      value - allowed object is byte[]

    • getRevisionsSaltValue

      public byte[] getRevisionsSaltValue()
      Gets the value of the revisionsSaltValue property.
      Returns:
      possible object is byte[]

    • setRevisionsSaltValue

      public void setRevisionsSaltValue(byte[] value)
      Sets the value of the revisionsSaltValue property.
      Parameters:
      value - allowed object is byte[]

    • getRevisionsSpinCount

      public Long getRevisionsSpinCount()
      Gets the value of the revisionsSpinCount property.
      Returns:
      possible object is Long

    • setRevisionsSpinCount

      public void setRevisionsSpinCount(Long value)
      Sets the value of the revisionsSpinCount property.
      Parameters:
      value - allowed object is Long

    • getWorkbookAlgorithmName

      public String getWorkbookAlgorithmName()
      Gets the value of the workbookAlgorithmName property.
      Returns:
      possible object is String

    • setWorkbookAlgorithmName

      public void setWorkbookAlgorithmName(String value)
      Sets the value of the workbookAlgorithmName property.
      Parameters:
      value - allowed object is String

    • getWorkbookHashValue

      public byte[] getWorkbookHashValue()
      Gets the value of the workbookHashValue property.
      Returns:
      possible object is byte[]

    • setWorkbookHashValue

      public void setWorkbookHashValue(byte[] value)
      Sets the value of the workbookHashValue property.
      Parameters:
      value - allowed object is byte[]

    • getWorkbookSaltValue

      public byte[] getWorkbookSaltValue()
      Gets the value of the workbookSaltValue property.
      Returns:
      possible object is byte[]

    • setWorkbookSaltValue

      public void setWorkbookSaltValue(byte[] value)
      Sets the value of the workbookSaltValue property.
      Parameters:
      value - allowed object is byte[]

    • getWorkbookSpinCount

      public Long getWorkbookSpinCount()
      Gets the value of the workbookSpinCount property.
      Returns:
      possible object is Long

    • setWorkbookSpinCount

      public void setWorkbookSpinCount(Long value)
      Sets the value of the workbookSpinCount property.
      Parameters:
      value - allowed object is Long

    • getParent

      public Object getParent()
      Gets the parent object in the object tree representing the unmarshalled xml document.
      Specified by:
      getParent in interface Child
      Returns:
      The parent object.

    • setParent

      public void setParent(Object parent)
      Specified by:
      setParent in interface Child

    • afterUnmarshal

      public void afterUnmarshal(jakarta.xml.bind.Unmarshaller unmarshaller, Object parent)
      This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
      Parameters:
      parent - The parent object in the object tree.
      unmarshaller - The unmarshaller that generated the instance.