Top Fields Constructors Methods
org.apache.poi.ddf

public Class EscherBlipRecord

extends EscherRecord
Class Inheritance
Known Direct Subclasses
org.apache.poi.ddf.EscherMetafileBlip, org.apache.poi.ddf.EscherBitmapBlip
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .IOUtils, .LittleEndian

Field Summary

Modifier and TypeField and Description
private static final int
DEFAULT_MAX_RECORD_LENGTH

private byte[]
field_pictureData

private static final int
HEADER_SIZE

private static int
MAX_RECORD_LENGTH

public static final short
RECORD_ID_END

public static final short
RECORD_ID_START

Constructor Summary

AccessConstructor and Description
public
EscherBlipRecord()

public
EscherBlipRecord(EscherBlipRecord other)

Method Summary

Modifier and TypeMethod and Description
public EscherBlipRecord
copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public int
fillFields(byte[]
The byte array containing the serialized escher records.
data, int
The offset into the byte array.
offset, EscherRecordFactory
A factory for creating new escher records.
recordFactory)

Implements abstract org.apache.poi.ddf.EscherRecord.fillFields.

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

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

Overrides org.apache.poi.ddf.EscherRecord.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public Enum<E extends Enum<E>>
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

public static int

Returns:

the max record length allowed for EscherBlipRecord
getMaxRecordLength()

public byte[]

Returns:

the picture data
getPicturedata()

Gets the picture data bytes

public String
getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

public int
getRecordSize()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordSize.

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

public int
serialize(int
the offset within the byte array
offset, byte[]
the data array to serialize to
data, EscherSerializationListener
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.
listener)

Implements abstract org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

public static void
setMaxRecordLength(int
the max record length allowed for EscherBlipRecord
length)

public void
setPictureData(byte[]
the picture data
pictureData)

Sets the picture data bytes

public void
setPictureData(byte[]
the picture data
pictureData, int
the offset into the picture data
offset, int
the amount of bytes to be used
length)

Sets the picture data bytes

Inherited from org.apache.poi.ddf.EscherRecord:
displayfillFieldsgetChildgetChildRecordsgetGenericChildrengetInstancegetOptionsgetRecordIdgetVersionisContainerRecordreadHeaderreadInstanceserializeserializesetChildRecordssetInstancesetOptionssetRecordIdsetVersiontoStringtoXmltoXml

Field Detail

DEFAULT_MAX_RECORD_LENGTHback to summary
private static final int DEFAULT_MAX_RECORD_LENGTH
field_pictureDataback to summary
private byte[] field_pictureData
HEADER_SIZEback to summary
private static final int HEADER_SIZE
MAX_RECORD_LENGTHback to summary
private static int MAX_RECORD_LENGTH
RECORD_ID_ENDback to summary
public static final short RECORD_ID_END
RECORD_ID_STARTback to summary
public static final short RECORD_ID_START

Constructor Detail

EscherBlipRecordback to summary
public EscherBlipRecord()
EscherBlipRecordback to summary
public EscherBlipRecord(EscherBlipRecord other)

Method Detail

copyback to summary
public EscherBlipRecord copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:EscherBlipRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
fillFieldsback to summary
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)

Implements abstract org.apache.poi.ddf.EscherRecord.fillFields.

Doc from org.apache.poi.ddf.EscherRecord.fillFields.

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

Parameters
data:byte[]

The byte array containing the serialized escher records.

offset:int

The offset into the byte array.

recordFactory:EscherRecordFactory

A factory for creating new escher records.

Returns:int

The number of bytes written.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ddf.EscherRecord.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public Enum<E extends Enum<E>> getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Annotations
@Override
getMaxRecordLengthback to summary
public static int getMaxRecordLength()
Returns:int

the max record length allowed for EscherBlipRecord

getPicturedataback to summary
public byte[] getPicturedata()

Gets the picture data bytes

Returns:byte[]

the picture data

getRecordNameback to summary
public String getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Doc from org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

Returns:String

the short name for this escher record

Annotations
@Override
getRecordSizeback to summary
public int getRecordSize()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordSize.

Doc from org.apache.poi.ddf.EscherRecord.getRecordSize.

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

Returns:int

number of bytes

Annotations
@Override
serializeback to summary
public int serialize(int offset, byte[] data, EscherSerializationListener listener)

Implements abstract org.apache.poi.ddf.EscherRecord.serialize.

Doc from org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

Parameters
offset:int

the offset within the byte array

data:byte[]

the data array to serialize to

listener:EscherSerializationListener

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:int

the number of bytes written.

Annotations
@Override
setMaxRecordLengthback to summary
public static void setMaxRecordLength(int length)
Parameters
length:int

the max record length allowed for EscherBlipRecord

setPictureDataback to summary
public void setPictureData(byte[] pictureData)

Sets the picture data bytes

Parameters
pictureData:byte[]

the picture data

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

Sets the picture data bytes

Parameters
pictureData:byte[]

the picture data

offset:int

the offset into the picture data

length:int

the amount of bytes to be used