FileDocCategorySizeDatePackage
ClassID.javaAPI DocApache Poi 3.0.16727Mon Jan 01 12:39:34 GMT 2007org.apache.poi.hpsf

ClassID

public class ClassID extends Object

Represents a class ID (16 bytes). Unlike other little-endian type the {@link 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 <klute@rainer-klute.de>
version
$Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
since
2002-02-09

Fields Summary
protected byte[]
bytes

The bytes making out the class ID in correct order, i.e. big-endian.

public static final int
LENGTH

The number of bytes occupied by this object in the byte stream.

Constructors Summary
public ClassID(byte[] src, int offset)

Creates a {@link ClassID} and reads its value from a byte array.

param
src The byte array to read from.
param
offset The offset of the first byte to read.

        read(src, offset);
    
public ClassID()

Creates a {@link ClassID} and initializes its value with 0x00 bytes.

        bytes = new byte[LENGTH];
        for (int i = 0; i < LENGTH; i++)
            bytes[i] = 0x00;
    
Methods Summary
public booleanequals(java.lang.Object o)

Checks whether this ClassID is equal to another object.

param
o the object to compare this PropertySet with
return
true if the objects are equal, else false.

        if (o == null || !(o instanceof ClassID))
            return false;
        final ClassID cid = (ClassID) o;
        if (bytes.length != cid.bytes.length)
            return false;
        for (int i = 0; i < bytes.length; i++)
            if (bytes[i] != cid.bytes[i])
                return false;
        return true;
    
public byte[]getBytes()

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

return
the bytes making out the class ID.

        return bytes;
    
public inthashCode()

see
Object#hashCode()

        return new String(bytes).hashCode();
    
public intlength()

return
The number of bytes occupied by this object in the byte stream.


                      
      
    
        return LENGTH;
    
public byte[]read(byte[] src, int offset)

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

param
src The byte array to read from
param
offset The offset within the src byte array
return
A byte array containing the class ID.

        bytes = new byte[16];

        /* Read double word. */
        bytes[0] = src[3 + offset];
        bytes[1] = src[2 + offset];
        bytes[2] = src[1 + offset];
        bytes[3] = src[0 + offset];

        /* Read first word. */
        bytes[4] = src[5 + offset];
        bytes[5] = src[4 + offset];

        /* Read second word. */
        bytes[6] = src[7 + offset];
        bytes[7] = src[6 + offset];

        /* Read 8 bytes. */
        for (int i = 8; i < 16; i++)
            bytes[i] = src[i + offset];

        return bytes;
    
public voidsetBytes(byte[] bytes)

Sets the bytes making out the class ID.

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

        for (int i = 0; i < this.bytes.length; i++)
            this.bytes[i] = bytes[i];
    
public java.lang.StringtoString()

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

return
String representation of the Class ID represented by this object.

        StringBuffer sbClassId = new StringBuffer(38);
        sbClassId.append('{");
        for (int i = 0; i < 16; i++)
        {
            sbClassId.append(HexDump.toHex(bytes[i]));
            if (i == 3 || i == 5 || i == 7 || i == 9)
                sbClassId.append('-");
        }
        sbClassId.append('}");
        return sbClassId.toString();
    
public voidwrite(byte[] dst, int offset)

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

param
dst The byte array to write to.
param
offset The offset within the dst byte array.
exception
ArrayStoreException if there is not enough room for the class ID 16 bytes in the byte array after the offset position.

        /* Check array size: */
        if (dst.length < 16)
            throw new ArrayStoreException
                ("Destination byte[] must have room for at least 16 bytes, " +
                 "but has a length of only " + dst.length + ".");
        /* Write double word. */
        dst[0 + offset] = bytes[3];
        dst[1 + offset] = bytes[2];
        dst[2 + offset] = bytes[1];
        dst[3 + offset] = bytes[0];

        /* Write first word. */
        dst[4 + offset] = bytes[5];
        dst[5 + offset] = bytes[4];

        /* Write second word. */
        dst[6 + offset] = bytes[7];
        dst[7 + offset] = bytes[6];

        /* Write 8 bytes. */
        for (int i = 8; i < 16; i++)
            dst[i + offset] = bytes[i];