Package org.apache.poi.ddf

Class EscherBlipRecord

java.lang.Object

org.apache.poi.ddf.EscherRecord

org.apache.poi.ddf.EscherBlipRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

Direct Known Subclasses:

EscherBitmapBlip, EscherMetafileBlip

public class EscherBlipRecord
extends EscherRecord

Field Summary

Fields

Modifier and Type	Field	Description
static short	RECORD_ID_END
static short	RECORD_ID_START

Constructor Summary

Constructors

Constructor	Description
EscherBlipRecord()
EscherBlipRecord(EscherBlipRecord other)

Method Summary

Modifier and Type	Method	Description
EscherBlipRecord	copy()
int	fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)	The contract of this method is to deserialize an escher record including its children.
Map<String,Supplier<?>>	getGenericProperties()
Enum	getGenericRecordType()
static int	getMaxRecordLength()
byte[]	getPicturedata()	Gets the picture data bytes
String	getRecordName()	Subclasses should return the short name for this escher record.
int	getRecordSize()	Subclasses should effeciently return the number of bytes required to serialize the record.
int	serialize(int offset, byte[] data, EscherSerializationListener listener)	Serializes the record to an existing byte array.
static void	setMaxRecordLength(int length)
void	setPictureData(byte[] pictureData)	Sets the picture data bytes
void	setPictureData(byte[] pictureData, int offset, int length)	Sets the picture data bytes

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

display, fillFields, getChild, getChildRecords, getGenericChildren, getInstance, getOptions, getRecordId, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RECORD_ID_START

public static final short RECORD_ID_START

RECORD_ID_END

public static final short RECORD_ID_END

Constructor Detail

EscherBlipRecord

public EscherBlipRecord()

EscherBlipRecord

public EscherBlipRecord(EscherBlipRecord other)

Method Detail

setMaxRecordLength

public static void setMaxRecordLength(int length)

Parameters:

length - the max record length allowed for EscherBlipRecord

getMaxRecordLength

public static int getMaxRecordLength()

Returns:

the max record length allowed for EscherBlipRecord

fillFields

public int fillFields(byte[] data,
                      int offset,
                      EscherRecordFactory recordFactory)

Description copied from class: EscherRecord

The contract of this method is to deserialize an escher record including its children.

Specified by:

fillFields in class EscherRecord

Parameters:

data - The byte array containing the serialized escher records.

offset - The offset into the byte array.

recordFactory - A factory for creating new escher records.

Returns:

The number of bytes written.

serialize

public int serialize(int offset,
                     byte[] data,
                     EscherSerializationListener listener)

Description copied from class: EscherRecord

Serializes the record to an existing byte array.

Specified by:

serialize in class EscherRecord

Parameters:

offset - the offset within the byte array

data - the data array to serialize to

listener - a listener for begin and end serialization events. This is useful because the serialization is hierarchical/recursive and sometimes you need to be able break into that.

Returns:

the number of bytes written.

getRecordSize

public int getRecordSize()

Description copied from class: EscherRecord

Subclasses should effeciently return the number of bytes required to serialize the record.

Specified by:

getRecordSize in class EscherRecord

Returns:

number of bytes

getRecordName

public String getRecordName()

Description copied from class: EscherRecord

Subclasses should return the short name for this escher record.

Specified by:

getRecordName in class EscherRecord

Returns:

the short name for this escher record

getPicturedata

public byte[] getPicturedata()

Gets the picture data bytes

Returns:

the picture data

setPictureData

public void setPictureData(byte[] pictureData)

Sets the picture data bytes

Parameters:

pictureData - the picture data

setPictureData

public void setPictureData(byte[] pictureData,
                           int offset,
                           int length)

Sets the picture data bytes

Parameters:

pictureData - the picture data

offset - the offset into the picture data

length - the amount of bytes to be used

getGenericProperties

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

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class EscherRecord

getGenericRecordType

public Enum getGenericRecordType()

copy

public EscherBlipRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class EscherRecord

Returns:

a deep copy of the implementing class / instance