Package org.docx4j.org.apache.poi.hpsf

Class ClassID

java.lang.Object
org.docx4j.org.apache.poi.hpsf.ClassID
public class ClassID
extends java.lang.Object

Represents a class ID (16 bytes). Unlike other little-endian type the ClassID is not just 16 bytes stored in the wrong order. Instead, it is a double word (4 bytes) followed by two words (2 bytes each) followed by 8 bytes.

Author:
Rainer Klute <[email protected]>

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected byte[] bytes
    The bytes making out the class ID in correct order, i.e.
    static ClassID EQUATION30  
    static ClassID EXCEL95  
    static ClassID EXCEL97  
    static int LENGTH
    The number of bytes occupied by this object in the byte stream.
    static ClassID OLE10_PACKAGE  
    static ClassID POWERPOINT95  
    static ClassID POWERPOINT97  
    static ClassID PPT_SHOW  
    static ClassID TXT_ONLY  
    static ClassID WORD95  
    static ClassID WORD97  
    static ClassID XLS_WORKBOOK  

  • Constructor Summary

    Constructors 
    Constructor Description
    ClassID()
    Creates a ClassID and initializes its value with 0x00 bytes.
    ClassID​(byte[] src, int offset)
    Creates a ClassID and reads its value from a byte array.
    ClassID​(java.lang.String externalForm)
    Creates a ClassID from a human-readable representation of the Class ID in standard format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)
    Checks whether this ClassID is equal to another object.
    byte[] getBytes()
    Gets the bytes making out the class ID.
    int hashCode()  
    int length()  
    byte[] read​(byte[] src, int offset)
    Reads the class ID's value from a byte array by turning little-endian into big-endian.
    void setBytes​(byte[] bytes)
    Sets the bytes making out the class ID.
    java.lang.String toString()
    Returns a human-readable representation of the Class ID in standard format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
    void write​(byte[] dst, int offset)
    Writes the class ID to a byte array in the little-endian format.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • ClassID

      public ClassID​(byte[] src, int offset)

      Creates a ClassID and reads its value from a byte array.

      Parameters:
      src - The byte array to read from.
      offset - The offset of the first byte to read.

    • ClassID

      public ClassID()

      Creates a ClassID and initializes its value with 0x00 bytes.

    • ClassID

      public ClassID​(java.lang.String externalForm)

      Creates a ClassID from a human-readable representation of the Class ID in standard format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".

      Parameters:
      externalForm - representation of the Class ID represented by this object.

  • Method Details

    • length

      public int length()
      Returns:
      The number of bytes occupied by this object in the byte stream.

    • getBytes

      public byte[] getBytes()

      Gets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.

      Returns:
      the bytes making out the class ID.

    • setBytes

      public void setBytes​(byte[] bytes)

      Sets the bytes making out the class ID.

      Parameters:
      bytes - The bytes making out the class ID in big-endian format. They are copied without their order being changed.

    • read

      public byte[] read​(byte[] src, int offset)

      Reads the class ID's value from a byte array by turning little-endian into big-endian.

      Parameters:
      src - The byte array to read from
      offset - The offset within the src byte array
      Returns:
      A byte array containing the class ID.

    • write

      public void write​(byte[] dst, int offset) throws java.lang.ArrayStoreException

      Writes the class ID to a byte array in the little-endian format.

      Parameters:
      dst - The byte array to write to.
      offset - The offset within the dst byte array.
      Throws:
      java.lang.ArrayStoreException - if there is not enough room for the class ID 16 bytes in the byte array after the offset position.

    • equals

      public boolean equals​(java.lang.Object o)

      Checks whether this ClassID is equal to another object.

      Overrides:
      equals in class java.lang.Object
      Parameters:
      o - the object to compare this PropertySet with
      Returns:
      true if the objects are equal, else false.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
      See Also:
      Object.hashCode()

    • toString

      public java.lang.String toString()

      Returns a human-readable representation of the Class ID in standard format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".

      Overrides:
      toString in class java.lang.Object
      Returns:
      String representation of the Class ID represented by this object.