org.apache.poi.ddf

Class EscherComplexProperty

java.lang.Object

org.apache.poi.ddf.EscherProperty

org.apache.poi.ddf.EscherComplexProperty

All Implemented Interfaces:

GenericRecord

Direct Known Subclasses:

EscherArrayProperty

public class EscherComplexProperty
extends EscherProperty

A complex property differs from a simple property in that the data can not fit inside a 32 bit integer. See the specification for more detailed information regarding exactly what is stored here.

Constructor Summary

Constructors

Constructor and Description
EscherComplexProperty(EscherPropertyTypes type, boolean isBlipId, int complexSize) Create a complex property using the property type, a flag to indicate whether this is a blip reference and the complex property data size.
EscherComplexProperty(short propertyNumber, boolean isBlipId, byte[] complexData) Deprecated.
EscherComplexProperty(short propertyNumber, boolean isBlipId, int complexSize) Create a complex property using the property number, a flag to indicate whether this is a blip reference and the complex property data size.
EscherComplexProperty(short id, byte[] complexData) Deprecated.
EscherComplexProperty(short id, int complexSize) Create a complex property using the property id and a byte array containing the complex data value size.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Determine whether this property is equal to another property.
byte[]	getComplexData() Get the complex data value.
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
int	getPropertySize() Calculates the number of bytes required to serialize this property.
int	hashCode()
protected void	resizeComplexData(int newSize)
protected void	resizeComplexData(int newSize, int copyLen)
int	serializeComplexPart(byte[] data, int pos) Serializes the complex part of this property
int	serializeSimplePart(byte[] data, int pos) Serializes the simple part of this property.
int	setComplexData(byte[] complexData)
int	setComplexData(byte[] complexData, int offset)

Methods inherited from class org.apache.poi.ddf.EscherProperty

getGenericChildren, getGenericRecordType, getId, getName, getPropertyNumber, isBlipId, isComplex, toString, toXml

Methods inherited from class java.lang.Object

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

Constructor Detail

EscherComplexProperty

@Deprecated
 @Removal(version="5.0.0")
public EscherComplexProperty(short id,
                                                                    byte[] complexData)

Deprecated.

Create a complex property using the property id and a byte array containing the complex data value.

Parameters:

id - The id consists of the property number, a flag indicating whether this is a blip id and a flag indicating that this is a complex property.

complexData - The value of this property.

EscherComplexProperty

@Deprecated
 @Removal(version="5.0.0")
public EscherComplexProperty(short propertyNumber,
                                                                    boolean isBlipId,
                                                                    byte[] complexData)

Deprecated.

Create a complex property using the property number, a flag to indicate whether this is a blip reference and the complex property data.

Parameters:

propertyNumber - The property number

isBlipId - Whether this is a blip id. Should be false.

complexData - The value of this complex property.

EscherComplexProperty

public EscherComplexProperty(short id,
                             int complexSize)

Create a complex property using the property id and a byte array containing the complex data value size.

Parameters:

id - The id consists of the property number, a flag indicating whether this is a blip id and a flag indicating that this is a complex property.

complexSize - The byte size of this property.

EscherComplexProperty

public EscherComplexProperty(short propertyNumber,
                             boolean isBlipId,
                             int complexSize)

Create a complex property using the property number, a flag to indicate whether this is a blip reference and the complex property data size.

Parameters:

propertyNumber - The property number

isBlipId - Whether this is a blip id. Should be false.

complexSize - The byte size of this property.

EscherComplexProperty

public EscherComplexProperty(EscherPropertyTypes type,
                             boolean isBlipId,
                             int complexSize)

Create a complex property using the property type, a flag to indicate whether this is a blip reference and the complex property data size.

Parameters:

type - The property type

isBlipId - Whether this is a blip id. Should be false.

complexSize - The byte size of this property.

Method Detail

serializeSimplePart

public int serializeSimplePart(byte[] data,
                               int pos)

Serializes the simple part of this property. i.e. the first 6 bytes.

Specified by:

serializeSimplePart in class EscherProperty

Parameters:

data - the buffer to write to

pos - the starting position

Returns:

the length of the part

serializeComplexPart

public int serializeComplexPart(byte[] data,
                                int pos)

Serializes the complex part of this property

Specified by:

serializeComplexPart in class EscherProperty

Parameters:

data - The data array to serialize to

pos - The offset within data to start serializing to.

Returns:

The number of bytes serialized.

getComplexData

public byte[] getComplexData()

Get the complex data value.

Returns:

the complex bytes

setComplexData

public int setComplexData(byte[] complexData)

setComplexData

public int setComplexData(byte[] complexData,
                          int offset)

resizeComplexData

protected void resizeComplexData(int newSize)

resizeComplexData

protected void resizeComplexData(int newSize,
                                 int copyLen)

equals

public boolean equals(java.lang.Object o)

Determine whether this property is equal to another property.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare to.

Returns:

True if the objects are equal.

getPropertySize

public int getPropertySize()

Calculates the number of bytes required to serialize this property.

Overrides:

getPropertySize in class EscherProperty

Returns:

Number of bytes

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class EscherProperty