Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

corrected javadoc for StandardRecord#serialize(LittleEndianOutput out) as reported in poi-dev 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1232321 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2012-01-17 06:53:45 +00:00
parent 797ff02699
commit 013ba86bb0
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/java/org/apache/poi/hssf/record/StandardRecord.java
View File

@ -31,6 +31,13 @@ public abstract class StandardRecord extends Record {
public final int getRecordSize() { public final int getRecordSize() {
return 4 + getDataSize(); return 4 + getDataSize();
} }
/**
* Write the data content of this BIFF record including the sid and record length.<br/>
*
* The subclass must write the exact number of bytes as reported by
* {@link org.apache.poi.hssf.record.Record#getRecordSize()}}
*/
@Override @Override
public final int serialize(int offset, byte[] data) { public final int serialize(int offset, byte[] data) {
int dataSize = getDataSize(); int dataSize = getDataSize();
@ -47,11 +54,14 @@ public abstract class StandardRecord extends Record {
return recSize; return recSize;
} }
/** /**
* Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields * Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
* have already been written by the superclass.<br/> * have already been written by the superclass.<br/>
* *
* The subclass must write the exact number of bytes as reported by {@link org.apache.poi.hssf.record.Record#getRecordSize()}} * The number of bytes written must equal the record size reported by
*/ * {@link org.apache.poi.hssf.record.Record#getRecordSize()}} minus four
* ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
* by thye superclass).
*/
protected abstract void serialize(LittleEndianOutput out); protected abstract void serialize(LittleEndianOutput out);
} }