You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2010/01/19 13:02:10 UTC

svn commit: r900744 - /poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java

Author: nick
Date: Tue Jan 19 12:02:10 2010
New Revision: 900744

URL: http://svn.apache.org/viewvc?rev=900744&view=rev
Log:
Add more documentation, and make the constructor public for testing use

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

Modified: poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java?rev=900744&r1=900743&r2=900744&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordOutput.java Tue Jan 19 12:02:10 2010
@@ -35,7 +35,7 @@
 	private UnknownLengthRecordOutput _ulrOutput;
 	private int _totalPreviousRecordsSize;
 
-	ContinuableRecordOutput(LittleEndianOutput out, int sid) {
+	public ContinuableRecordOutput(LittleEndianOutput out, int sid) {
 		_ulrOutput = new UnknownLengthRecordOutput(out, sid);
 		_out = out;
 		_totalPreviousRecordsSize = 0;
@@ -73,6 +73,11 @@
 		_totalPreviousRecordsSize += _ulrOutput.getTotalSize();
 		_ulrOutput = new UnknownLengthRecordOutput(_out, ContinueRecord.sid);
 	}
+	/**
+	 * Will terminate the current record and start a new {@link ContinueRecord}
+	 *  if there isn't space for the requested number of bytes
+	 * @param requiredContinuousSize The number of bytes that need to be written
+	 */
 	public void writeContinueIfRequired(int requiredContinuousSize) {
 		if (_ulrOutput.getAvailableSpace() < requiredContinuousSize) {
 			writeContinue();



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