Apache POI - Common 5.3.0 · org.apache.poi.ddf.EscherRecord

Modifier and Type	Field and Description
private short	_options
private short	_recordId
private static final BitField	fInstance
private static final BitField	fVersion

Access	Constructor and Description
public	EscherRecord() Create a new instance
protected	EscherRecord(EscherRecord other)

Method Summary

Modifier and Type	Method and Description
public abstract EscherRecord	copy() Redeclares org.apache.poi.common.Duplicatable.copy.
public void	display(PrintWriter The print writer to output to. w, int The current indent level. indent) The display methods allows escher variables to print the record names according to their hierarchy.
protected int	Returns: The number of bytes written. fillFields(byte[] they bytes to serialize from data, EscherRecordFactory the escher record factory f) Delegates to fillFields(byte[], int, EscherRecordFactory)
public abstract int	Returns: The number of bytes written. 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) The contract of this method is to deserialize an escher record including its children.
public EscherRecord	Returns: the indexed child record getChild(int the index of the child within the child records index) Returns the indexed child record.
public List<EscherRecord>	Returns: Returns the children of this record. By default this will be an empty list. EscherCotainerRecord is the only record that may contain children. getChildRecords()
public List<? extends GenericRecord>	getGenericChildren() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericChildren.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public short	Returns: The instance part of the record getInstance() Returns the instance part of the option record.
public short	Returns: The options field for this record. All records have one. getOptions() Note that `options` is an internal field.
public short	Returns: The 16 bit record id. getRecordId() Return the current record id.
public abstract String	Returns: the short name for this escher record getRecordName() Subclasses should return the short name for this escher record.
public abstract int	Returns: number of bytes getRecordSize() Subclasses should effeciently return the number of bytes required to serialize the record.
public short	Returns: The version part of the option record getVersion() Returns the version part of the option record.
public boolean	Returns: true is this is a container field. isContainerRecord() Determine whether this is a container record by inspecting the option field.
protected int	Returns: the number of bytes remaining in this record. This may include the children if this is a container. readHeader(byte[] the byte array to read from data, int the offset to start reading from offset) Reads the 8 byte header information and populates the `options` and `recordId` records.
protected static short	Returns: value of instance part of options field readInstance(byte[] the byte array to read from data, int the offset to start reading from offset) Read the options field from header and return instance part of it.
public byte[]	Returns: the serialized record. serialize() Serializes to a new byte array.
public int	Returns: The number of bytes written. serialize(int the offset within the data byte array. offset, byte[] the data array to serialize to. data) Serializes to an existing byte array without serialization listener.
public abstract int	Returns: the number of bytes written. 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) Serializes the record to an existing byte array.
public void	setChildRecords(List<EscherRecord> Not used in base implementation. childRecords) Sets the child records for this record.
public void	setInstance(short instance part value value) Sets the instance part of record
public void	setOptions(short the record options options) Set the options this record.
public void	setRecordId(short the record id recordId) Sets the record id for this record.
public void	setVersion(short version part value value) Sets the version part of record
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toXml()
public final String	Returns: xml representation of this record toXml(String - each children must be indented right relative to its parent tab)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

_options	back to summary
private short _options

_recordId	back to summary
private short _recordId

fInstance	back to summary
private static final BitField fInstance

fVersion	back to summary
private static final BitField fVersion

EscherRecord	back to summary
public EscherRecord() Create a new instance

EscherRecord	back to summary
protected EscherRecord(EscherRecord other)

Method Detail

copy	back to summary
public abstract EscherRecord copy() Redeclares org.apache.poi.common.Duplicatable.copy. Returns:EscherRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public abstract EscherRecord copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Returns:EscherRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

display	back to summary
public void display(PrintWriter w, int indent) The display methods allows escher variables to print the record names according to their hierarchy. Parameters w:PrintWriter The print writer to output to. indent:int The current indent level.

display

back to summary

public void display(PrintWriter w, int indent)

The display methods allows escher variables to print the record names according to their hierarchy.

Parameters

w:PrintWriter: The print writer to output to.
indent:int: The current indent level.

fillFields back to summary

fillFields	back to summary
protected int fillFields(byte[] data, EscherRecordFactory f) Delegates to fillFields(byte[], int, EscherRecordFactory) Parameters data:byte[] they bytes to serialize from f:EscherRecordFactory the escher record factory Returns:int The number of bytes written. See Also `fillFields(byte[], int, org.apache.poi.ddf.EscherRecordFactory)`

protected int fillFields(byte[] data, EscherRecordFactory f)

Delegates to fillFields(byte[], int, EscherRecordFactory)

Parameters

data:byte[]: they bytes to serialize from
f:EscherRecordFactory: the escher record factory

Returns:int

The number of bytes written.

fillFields	back to summary
public abstract int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) 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.

fillFields

back to summary

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

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.

getChild	back to summary
public EscherRecord getChild(int index) Returns the indexed child record. Parameters index:int the index of the child within the child records Returns:EscherRecord the indexed child record

getChild

back to summary

public EscherRecord getChild(int index)

Returns the indexed child record.

Parameters

index:int: the index of the child within the child records

Returns:EscherRecord

the indexed child record

getChildRecords	back to summary
public List<EscherRecord> getChildRecords() Returns:List<EscherRecord> Returns the children of this record. By default this will be an empty list. EscherCotainerRecord is the only record that may contain children. See Also `EscherContainerRecord`

getGenericChildren	back to summary
public List<? extends GenericRecord> getGenericChildren() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericChildren. Annotations @Override

getGenericChildren

back to summary

public List<? extends GenericRecord> getGenericChildren()

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

Annotations

@Override

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

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

Annotations

@Override

getInstance	back to summary
public short getInstance() Returns the instance part of the option record. Returns:short The instance part of the record

getInstance

back to summary

public short getInstance()

Returns the instance part of the option record.

Returns:short: The instance part of the record

getOptions back to summary

getOptions	back to summary
public short getOptions() Note that `options` is an internal field. Use `setInstance(short)` ()} and `setVersion(short)` ()} to set the actual fields. Returns:short The options field for this record. All records have one. Annotations @Internal

public short getOptions()

Note that options is an internal field. Use setInstance(short) ()} and setVersion(short) ()} to set the actual fields.

Returns:short

The options field for this record. All records have one.

Annotations

@Internal

getRecordId	back to summary
public short getRecordId() Return the current record id. Returns:short The 16 bit record id.

getRecordId

back to summary

public short getRecordId()

Return the current record id.

Returns:short: The 16 bit record id.

getRecordName	back to summary
public abstract String getRecordName() Subclasses should return the short name for this escher record. Returns:String the short name for this escher record

getRecordName

back to summary

public abstract String getRecordName()

Subclasses should return the short name for this escher record.

Returns:String: the short name for this escher record

getRecordSize	back to summary
public abstract int getRecordSize() Subclasses should effeciently return the number of bytes required to serialize the record. Returns:int number of bytes

getRecordSize

back to summary

public abstract int getRecordSize()

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

Returns:int: number of bytes

getVersion	back to summary
public short getVersion() Returns the version part of the option record. Returns:short The version part of the option record

getVersion

back to summary

public short getVersion()

Returns the version part of the option record.

Returns:short: The version part of the option record

isContainerRecord	back to summary
public boolean isContainerRecord() Determine whether this is a container record by inspecting the option field. Returns:boolean true is this is a container field.

isContainerRecord

back to summary

public boolean isContainerRecord()

Determine whether this is a container record by inspecting the option field.

Returns:boolean: true is this is a container field.

readHeader back to summary

readHeader	back to summary
protected int readHeader(byte[] data, int offset) Reads the 8 byte header information and populates the `options` and `recordId` records. Parameters data:byte[] the byte array to read from offset:int the offset to start reading from Returns:int the number of bytes remaining in this record. This may include the children if this is a container.

protected int readHeader(byte[] data, int offset)

Reads the 8 byte header information and populates the options and recordId records.

Parameters

data:byte[]: the byte array to read from
offset:int: the offset to start reading from

Returns:int

the number of bytes remaining in this record. This may include the children if this is a container.

readInstance	back to summary
protected static short readInstance(byte[] data, int offset) Read the options field from header and return instance part of it. Parameters data:byte[] the byte array to read from offset:int the offset to start reading from Returns:short value of instance part of options field

readInstance

back to summary

protected static short readInstance(byte[] data, int offset)

Read the options field from header and return instance part of it.

Parameters

data:byte[]: the byte array to read from
offset:int: the offset to start reading from

Returns:short

value of instance part of options field

serialize back to summary

serialize	back to summary
public byte[] serialize() Serializes to a new byte array. This is done by delegating to serialize(int, byte[]); Returns:byte[] the serialized record. See Also `serialize(int, byte[])`

public byte[] serialize()

Serializes to a new byte array. This is done by delegating to serialize(int, byte[]);

Returns:byte[]: the serialized record.
See Also: serialize(int, byte[])

serialize back to summary

serialize	back to summary
public int serialize(int offset, byte[] data) Serializes to an existing byte array without serialization listener. This is done by delegating to serialize(int, byte[], EscherSerializationListener). Parameters offset:int the offset within the data byte array. data:byte[] the data array to serialize to. Returns:int The number of bytes written. See Also `serialize(int, byte[], org.apache.poi.ddf.EscherSerializationListener)`

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

Serializes to an existing byte array without serialization listener. This is done by delegating to serialize(int, byte[], EscherSerializationListener).

Parameters

offset:int: the offset within the data byte array.
data:byte[]: the data array to serialize to.

Returns:int

The number of bytes written.

serialize	back to summary
public abstract int serialize(int offset, byte[] data, EscherSerializationListener listener) 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.

serialize

back to summary

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

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.

setChildRecords	back to summary
public void setChildRecords(List<EscherRecord> childRecords) Sets the child records for this record. By default this will throw an exception as only EscherContainerRecords may have children. Parameters childRecords:List<EscherRecord> Not used in base implementation.

setChildRecords

back to summary

public void setChildRecords(List<EscherRecord> childRecords)

Sets the child records for this record. By default this will throw an exception as only EscherContainerRecords may have children.

Parameters

childRecords:List<EscherRecord>: Not used in base implementation.

setInstance	back to summary
public void setInstance(short value) Sets the instance part of record Parameters value:short instance part value

setInstance

back to summary

public void setInstance(short value)

Sets the instance part of record

Parameters

value:short: instance part value

setOptions back to summary

setOptions	back to summary
public void setOptions(short options) Set the options this record. Container records should have the last nibble set to 0xF. Note that `options` is an internal field. Use `getInstance()` and `getVersion()` to access actual fields. Parameters options:short the record options Annotations @Internal

public void setOptions(short options)

Set the options this record. Container records should have the last nibble set to 0xF.

Note that options is an internal field. Use getInstance() and getVersion() to access actual fields.

Parameters

options:short: the record options

Annotations

@Internal

setRecordId	back to summary
public void setRecordId(short recordId) Sets the record id for this record. Parameters recordId:short the record id

setRecordId

back to summary

public void setRecordId(short recordId)

Sets the record id for this record.

Parameters

recordId:short: the record id

setVersion	back to summary
public void setVersion(short value) Sets the version part of record Parameters value:short version part value

setVersion

back to summary

public void setVersion(short value)

Sets the version part of record

Parameters

value:short: version part value

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

toXml	back to summary
public String toXml()

toXml	back to summary
public final String toXml(String tab) Parameters tab:String - each children must be indented right relative to its parent Returns:String xml representation of this record

public abstract Class EscherRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail