Top Description Fields Constructors Methods

org.apache.poi.hssf.record.cont

pack-priv final Class UnknownLengthRecordOutput

Class Inheritance

extends Object
implements LittleEndianOutput

java.lang.Object
org.apache.poi.hssf.record.cont.UnknownLengthRecordOutput

All Implemented Interfaces

org.apache.poi.util.LittleEndianOutput

Imports

org.apache.poi.hssf.record.RecordInputStream, org.apache.poi.util.DelayableLittleEndianOutput, .LittleEndianByteArrayOutputStream, .LittleEndianOutput

Allows the writing of BIFF records when the 'ushort size' header field is not known in advance. When the client is finished writing data, it calls terminate(), at which point this class updates the 'ushort size' with its final value.

Field Summary

Modifier and Type	Field and Description
private final byte[]	_byteBuffer
private final LittleEndianOutput	_dataSizeOutput for writing the 'ushort size' field once its value is known
private final LittleEndianOutput	_originalOut
private LittleEndianOutput	_out
private int	_size
private static final int	MAX_DATA_SIZE

Constructor Summary

Access	Constructor and Description
public	UnknownLengthRecordOutput(LittleEndianOutput out, int sid)

Method Summary

Modifier and Type	Method and Description
public int	getAvailableSpace()
public int	getTotalSize() includes 4 byte header
public void	terminate() Finishes writing the current record and updates 'ushort size' field.
public void	write(byte[] b) Implements org.apache.poi.util.LittleEndianOutput.write.
public void	write(byte[] b, int offset, int len) Implements org.apache.poi.util.LittleEndianOutput.write.
public void	writeByte(int v) Implements org.apache.poi.util.LittleEndianOutput.writeByte.
public void	writeDouble(double v) Implements org.apache.poi.util.LittleEndianOutput.writeDouble.
public void	writeInt(int v) Implements org.apache.poi.util.LittleEndianOutput.writeInt.
public void	writeLong(long v) Implements org.apache.poi.util.LittleEndianOutput.writeLong.
public void	writeShort(int v) Implements org.apache.poi.util.LittleEndianOutput.writeShort.

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

Field Detail

_byteBuffer	back to summary
private final byte[] _byteBuffer

_dataSizeOutput	back to summary
private final LittleEndianOutput _dataSizeOutput for writing the 'ushort size' field once its value is known

_originalOut	back to summary
private final LittleEndianOutput _originalOut

_out	back to summary
private LittleEndianOutput _out

_size	back to summary
private int _size

MAX_DATA_SIZE	back to summary
private static final int MAX_DATA_SIZE

Constructor Detail

UnknownLengthRecordOutput	back to summary
public UnknownLengthRecordOutput(LittleEndianOutput out, int sid)

Method Detail

getAvailableSpace	back to summary
public int getAvailableSpace()

getTotalSize	back to summary
public int getTotalSize() includes 4 byte header

terminate	back to summary
public void terminate() Finishes writing the current record and updates 'ushort size' field. After this method is called, only `getTotalSize()` may be called.

write	back to summary
public void write(byte[] b) Implements org.apache.poi.util.LittleEndianOutput.write.

write	back to summary
public void write(byte[] b, int offset, int len) Implements org.apache.poi.util.LittleEndianOutput.write.

writeByte	back to summary
public void writeByte(int v) Implements org.apache.poi.util.LittleEndianOutput.writeByte.

writeDouble	back to summary
public void writeDouble(double v) Implements org.apache.poi.util.LittleEndianOutput.writeDouble.

writeInt	back to summary
public void writeInt(int v) Implements org.apache.poi.util.LittleEndianOutput.writeInt.

writeLong	back to summary
public void writeLong(long v) Implements org.apache.poi.util.LittleEndianOutput.writeLong.

writeShort	back to summary
public void writeShort(int v) Implements org.apache.poi.util.LittleEndianOutput.writeShort.