Package loci.poi.ddf
Class UnknownEscherRecord
- java.lang.Object
-
- loci.poi.ddf.EscherRecord
-
- loci.poi.ddf.UnknownEscherRecord
-
public class UnknownEscherRecord extends EscherRecord
This record is used whenever a escher record is encountered that we do not explicitly support.- Author:
- Glen Stampoultzis (glens at apache.org)
-
-
Constructor Summary
Constructors Constructor Description UnknownEscherRecord()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChildRecord(EscherRecord childRecord)
Object
clone()
Escher records may need to be clonable in the future.int
fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
This method deserializes the record from a byte array.List
getChildRecords()
byte[]
getData()
String
getRecordName()
The short name for this recordint
getRecordSize()
Returns the number of bytes that are required to serialize this record.int
serialize(int offset, byte[] data, EscherSerializationListener listener)
Writes this record and any contained records to the supplied byte array.void
setChildRecords(List childRecords)
Sets the child records for this record.String
toString()
-
Methods inherited from class loci.poi.ddf.EscherRecord
display, fillFields, getChild, getInstance, getOptions, getRecordId, isContainerRecord, readHeader, serialize, serialize, setOptions, setRecordId
-
-
-
-
Method Detail
-
fillFields
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
This method deserializes the record from a byte array.- Specified by:
fillFields
in classEscherRecord
- Parameters:
data
- The byte array containing the escher record informationoffset
- The starting offset intodata
.recordFactory
- May be null since this is not a container record.- Returns:
- The number of bytes read from the byte array.
-
serialize
public int serialize(int offset, byte[] data, EscherSerializationListener listener)
Writes this record and any contained records to the supplied byte array.- Specified by:
serialize
in classEscherRecord
- Parameters:
offset
- the offset within the byte arraydata
- the data array to serialize tolistener
- 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.
-
getData
public byte[] getData()
-
getRecordSize
public int getRecordSize()
Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSize
in classEscherRecord
- Returns:
- Number of bytes
-
getChildRecords
public List getChildRecords()
- Overrides:
getChildRecords
in classEscherRecord
- Returns:
- 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
-
setChildRecords
public void setChildRecords(List childRecords)
Description copied from class:EscherRecord
Sets the child records for this record. By default this will throw an exception as only EscherContainerRecords may have children.- Overrides:
setChildRecords
in classEscherRecord
- Parameters:
childRecords
- Not used in base implementation.
-
clone
public Object clone()
Description copied from class:EscherRecord
Escher records may need to be clonable in the future.- Overrides:
clone
in classEscherRecord
-
getRecordName
public String getRecordName()
The short name for this record- Specified by:
getRecordName
in classEscherRecord
-
addChildRecord
public void addChildRecord(EscherRecord childRecord)
-
-