poi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ye...@apache.org
Subject svn commit: r1232321 - /poi/trunk/src/java/org/apache/poi/hssf/record/StandardRecord.java
Date Tue, 17 Jan 2012 06:53:45 GMT
Author: yegor
Date: Tue Jan 17 06:53:45 2012
New Revision: 1232321

URL: http://svn.apache.org/viewvc?rev=1232321&view=rev
Log:
corrected javadoc for StandardRecord#serialize(LittleEndianOutput out) as reported in poi-dev

Modified:
    poi/trunk/src/java/org/apache/poi/hssf/record/StandardRecord.java

Modified: poi/trunk/src/java/org/apache/poi/hssf/record/StandardRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/StandardRecord.java?rev=1232321&r1=1232320&r2=1232321&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/StandardRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/StandardRecord.java Tue Jan 17 06:53:45
2012
@@ -31,6 +31,13 @@ public abstract class StandardRecord ext
 	public final int getRecordSize() {
 		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
 	public final int serialize(int offset, byte[] data) {
 		int dataSize = getDataSize();
@@ -47,11 +54,14 @@ public abstract class StandardRecord ext
 		return recSize;
 	}
 
-	/**
-	 * Write the data content of this BIFF record.  The 'ushort sid' and 'ushort size' header
fields
-	 * 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()}}
-	 */
+    /**
+     * Write the data content of this BIFF record.  The 'ushort sid' and 'ushort size' header
fields
+     * have already been written by the superclass.<br/>
+     *
+     * 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);
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org


Mime
View raw message