Modifier and Type	Class and Description
public static class	RecordInputStream.LeftoverDataException For use in BiffViewer which may construct `Record`s that don't completely read all available data.
private static class	RecordInputStream.SimpleHeaderInput

Field Summary

Modifier and Type	Field and Description
private final BiffHeaderInput	_bhi Header `LittleEndianInput` facet of the wrapped `InputStream`
private int	_currentDataLength Length of the data section of the current BIFF record (always 4 less than the total record size).
private int	_currentDataOffset index within the data section of the current BIFF record
private int	_currentSid the record identifier of the BIFF record currently being read
private final LittleEndianInput	_dataInput Data `LittleEndianInput` facet of the wrapped `InputStream`
private int	_markedDataOffset index within the data section when mark() was called
private int	_nextSid The BIFF record identifier for the next record is read when just as the current record is finished.
private static final int	DATA_LEN_NEEDS_TO_BE_READ When `_currentDataLength` has this value, it means that the previous BIFF record is finished, the next sid has been properly read, but the data size field has not been read yet.
private static final byte[]	EMPTY_BYTE_ARRAY
private static final int	INVALID_SID_VALUE
public static final short	MAX_RECORD_DATA_SIZE Maximum size of a single record (minus the 4 byte header) without a continue

Constructor Summary

Access	Constructor and Description
public	RecordInputStream(InputStream in)
public	RecordInputStream(InputStream in, EncryptionInfo key, int initialOffset)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the number of bytes available in the current BIFF record available() Implements org.apache.poi.util.LittleEndianInput.available.
private void	checkRecordPosition(int requiredByteCount)
public int	Returns: sid of next record. Can be called after hasNextRecord() getNextSid()
public short	getSid()
public boolean	Returns: true, if there's another record in the stream hasNextRecord() Note - this method is expected to be called only when completed reading the current BIFF record.
private boolean	Returns: `true` when a `ContinueRecord` is next. isContinueNext()
public boolean	isEncrypted()
public void	mark(int the read ahead limit readlimit) Mark the stream position - experimental function
public void	nextRecord() Moves to the next record in the stream.
public int	read(byte[] b, int off, int len)
public byte[]	Returns: all byte data for the current record readAllContinuedRemainder() Deprecated POI 2.0 Best to write an input stream that wraps this one where there is special sub record that may overlap continue records. Reads all byte data for the current record, including any that overlaps into any following continue records.
public byte	readByte() Implements org.apache.poi.util.LittleEndianInput.readByte. Reads an 8 bit, signed value
public String	readCompressedUnicode(int requestedLength)
public double	readDouble() Implements org.apache.poi.util.LittleEndianInput.readDouble.
public void	readFully(byte[] buf) Implements org.apache.poi.util.LittleEndianInput.readFully.
public void	readFully(byte[] buf, int off, int len) Implements org.apache.poi.util.LittleEndianInput.readFully.
private void	readFully(byte[] buf, int off, int len, boolean isPlain)
public int	readInt() Implements org.apache.poi.util.LittleEndianInput.readInt. Reads a 32 bit, signed value
public long	readLong() Implements org.apache.poi.util.LittleEndianInput.readLong. Reads a 64 bit, signed value
private int	Returns: the sid of the next record or `INVALID_SID_VALUE` if at end of stream readNextSid()
public void	readPlain(byte[] the byte array to receive the bytes buf, int the start offset into the byte array off, int the amount of bytes to fill len) Implements org.apache.poi.util.LittleEndianInput.readPlain. Usually acts the same as `readFully(byte[], int, int)`, but for an encrypted stream the raw (unencrypted) data is filled
public byte[]	Returns: The remaining bytes of the current record. readRemainder() Returns the remaining bytes for the current record.
public short	readShort() Implements org.apache.poi.util.LittleEndianInput.readShort. Reads a 16 bit, signed value
public String	readString()
private String	readStringCommon(int requestedLength, boolean pIsCompressedEncoding)
public int	readUByte() Implements org.apache.poi.util.LittleEndianInput.readUByte. Reads an 8 bit, unsigned value
public String	Returns: the converted string readUnicodeLEString(int the length of the final string requestedLength) given a byte array of 16-bit unicode characters, compress to 8-bit and return a string { 0x16, 0x00 } -0x16
public int	readUShort() Implements org.apache.poi.util.LittleEndianInput.readUShort. Reads a 16 bit, unsigned value.
public int	Returns: The number of bytes remaining in the current record remaining() The remaining number of bytes in the current record.
public void	reset() Resets the stream position to the previously marked position.

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

Field Detail

_bhi	back to summary
private final BiffHeaderInput _bhi Header `LittleEndianInput` facet of the wrapped `InputStream`

_currentDataLength	back to summary
private int _currentDataLength Length of the data section of the current BIFF record (always 4 less than the total record size). When uninitialised, this field is set to `DATA_LEN_NEEDS_TO_BE_READ`.

_currentDataOffset	back to summary
private int _currentDataOffset index within the data section of the current BIFF record

_currentSid	back to summary
private int _currentSid the record identifier of the BIFF record currently being read

_dataInput	back to summary
private final LittleEndianInput _dataInput Data `LittleEndianInput` facet of the wrapped `InputStream`

_markedDataOffset	back to summary
private int _markedDataOffset index within the data section when mark() was called

_nextSid	back to summary
private int _nextSid The BIFF record identifier for the next record is read when just as the current record is finished. This field is only really valid during the time that (`_currentDataLength` == `DATA_LEN_NEEDS_TO_BE_READ`). At most other times its value is not really the 'sid of the next record'. Wwhile mid-record, this field coincidentally holds the sid of the current record.

DATA_LEN_NEEDS_TO_BE_READ	back to summary
private static final int DATA_LEN_NEEDS_TO_BE_READ When `_currentDataLength` has this value, it means that the previous BIFF record is finished, the next sid has been properly read, but the data size field has not been read yet.

EMPTY_BYTE_ARRAY	back to summary
private static final byte[] EMPTY_BYTE_ARRAY

INVALID_SID_VALUE	back to summary
private static final int INVALID_SID_VALUE

MAX_RECORD_DATA_SIZE	back to summary
public static final short MAX_RECORD_DATA_SIZE Maximum size of a single record (minus the 4 byte header) without a continue

Constructor Detail

RecordInputStream	back to summary
public RecordInputStream(InputStream in) throws RecordFormatException

RecordInputStream	back to summary
public RecordInputStream(InputStream in, EncryptionInfo key, int initialOffset) throws RecordFormatException

Method Detail

available back to summary

available	back to summary
public int available() Implements org.apache.poi.util.LittleEndianInput.available. Returns:int the number of bytes available in the current BIFF record Annotations @Override See Also `remaining()`

public int available()

Implements org.apache.poi.util.LittleEndianInput.available.

Returns:int

the number of bytes available in the current BIFF record

Annotations

@Override

See Also

remaining()

checkRecordPosition	back to summary
private void checkRecordPosition(int requiredByteCount)

getNextSid	back to summary
public int getNextSid() Returns:int sid of next record. Can be called after hasNextRecord()

getSid	back to summary
public short getSid()

hasNextRecord	back to summary
public boolean hasNextRecord() throws LeftoverDataException Note - this method is expected to be called only when completed reading the current BIFF record. Returns:boolean true, if there's another record in the stream Exceptions LeftoverDataException: if this method is called before reaching the end of the current record.

hasNextRecord

back to summary

public boolean hasNextRecord() throws LeftoverDataException

Note - this method is expected to be called only when completed reading the current BIFF record.

Returns:boolean

true, if there's another record in the stream

Exceptions

LeftoverDataException:: if this method is called before reaching the end of the current record.

isContinueNext	back to summary
private boolean isContinueNext() Returns:boolean `true` when a `ContinueRecord` is next.

isEncrypted	back to summary
public boolean isEncrypted() Annotations @Internal

mark back to summary

mark	back to summary
public void mark(int readlimit) Mark the stream position - experimental function Parameters readlimit:int the read ahead limit Annotations @Internal See Also `InputStream#mark(int)`

public void mark(int readlimit)

Mark the stream position - experimental function

Parameters

readlimit:int: the read ahead limit

Annotations

@Internal

See Also

InputStream#mark(int)

nextRecord	back to summary
public void nextRecord() throws RecordFormatException Moves to the next record in the stream. Note The auto continue flag is reset to true

read	back to summary
public int read(byte[] b, int off, int len)

readAllContinuedRemainder	back to summary
public byte[] readAllContinuedRemainder() Deprecated POI 2.0 Best to write an input stream that wraps this one where there is special sub record that may overlap continue records. Reads all byte data for the current record, including any that overlaps into any following continue records. Returns:byte[] all byte data for the current record Annotations @Deprecated

readAllContinuedRemainder

back to summary

public byte[] readAllContinuedRemainder()

Deprecated

POI 2.0 Best to write an input stream that wraps this one where there is special sub record that may overlap continue records.

Reads all byte data for the current record, including any that overlaps into any following continue records.

Returns:byte[]

all byte data for the current record

Annotations

@Deprecated

readByte	back to summary
public byte readByte() Implements org.apache.poi.util.LittleEndianInput.readByte. Reads an 8 bit, signed value Annotations @Override

readByte

back to summary

public byte readByte()

Implements org.apache.poi.util.LittleEndianInput.readByte.

Reads an 8 bit, signed value

Annotations

@Override

readCompressedUnicode	back to summary
public String readCompressedUnicode(int requestedLength)

readDouble	back to summary
public double readDouble() Implements org.apache.poi.util.LittleEndianInput.readDouble. Annotations @Override

readDouble

back to summary

public double readDouble()

Implements org.apache.poi.util.LittleEndianInput.readDouble.

Annotations

@Override

readFully	back to summary
public void readFully(byte[] buf) Implements org.apache.poi.util.LittleEndianInput.readFully. Annotations @Override

readFully

back to summary

public void readFully(byte[] buf)

Implements org.apache.poi.util.LittleEndianInput.readFully.

Annotations

@Override

readFully	back to summary
public void readFully(byte[] buf, int off, int len) Implements org.apache.poi.util.LittleEndianInput.readFully. Annotations @Override

readFully

back to summary

public void readFully(byte[] buf, int off, int len)

Implements org.apache.poi.util.LittleEndianInput.readFully.

Annotations

@Override

readFully	back to summary
private void readFully(byte[] buf, int off, int len, boolean isPlain)

readInt	back to summary
public int readInt() Implements org.apache.poi.util.LittleEndianInput.readInt. Reads a 32 bit, signed value Annotations @Override

readInt

back to summary

public int readInt()

Implements org.apache.poi.util.LittleEndianInput.readInt.

Reads a 32 bit, signed value

Annotations

@Override

readLong	back to summary
public long readLong() Implements org.apache.poi.util.LittleEndianInput.readLong. Reads a 64 bit, signed value Annotations @Override

readLong

back to summary

public long readLong()

Implements org.apache.poi.util.LittleEndianInput.readLong.

Reads a 64 bit, signed value

Annotations

@Override

readNextSid	back to summary
private int readNextSid() Returns:int the sid of the next record or `INVALID_SID_VALUE` if at end of stream

readPlain back to summary

readPlain	back to summary
public void readPlain(byte[] buf, int off, int len) Implements org.apache.poi.util.LittleEndianInput.readPlain. Doc from org.apache.poi.util.LittleEndianInput.readPlain. Usually acts the same as `readFully(byte[], int, int)`, but for an encrypted stream the raw (unencrypted) data is filled Parameters buf:byte[] the byte array to receive the bytes off:int the start offset into the byte array len:int the amount of bytes to fill Annotations @Override

public void readPlain(byte[] buf, int off, int len)

Implements org.apache.poi.util.LittleEndianInput.readPlain.

Doc from org.apache.poi.util.LittleEndianInput.readPlain.

Usually acts the same as readFully(byte[], int, int), but for an encrypted stream the raw (unencrypted) data is filled

Parameters

buf:byte[]: the byte array to receive the bytes
off:int: the start offset into the byte array
len:int: the amount of bytes to fill

Annotations

@Override

readRemainder	back to summary
public byte[] readRemainder() Returns the remaining bytes for the current record. Returns:byte[] The remaining bytes of the current record.

readRemainder

back to summary

public byte[] readRemainder()

Returns the remaining bytes for the current record.

Returns:byte[]: The remaining bytes of the current record.

readShort	back to summary
public short readShort() Implements org.apache.poi.util.LittleEndianInput.readShort. Reads a 16 bit, signed value Annotations @Override

readShort

back to summary

public short readShort()

Implements org.apache.poi.util.LittleEndianInput.readShort.

Reads a 16 bit, signed value

Annotations

@Override

readString	back to summary
public String readString()

readStringCommon	back to summary
private String readStringCommon(int requestedLength, boolean pIsCompressedEncoding)

readUByte	back to summary
public int readUByte() Implements org.apache.poi.util.LittleEndianInput.readUByte. Reads an 8 bit, unsigned value Annotations @Override

readUByte

back to summary

public int readUByte()

Implements org.apache.poi.util.LittleEndianInput.readUByte.

Reads an 8 bit, unsigned value

Annotations

@Override

readUnicodeLEString	back to summary
public String readUnicodeLEString(int requestedLength) given a byte array of 16-bit unicode characters, compress to 8-bit and return a string { 0x16, 0x00 } -0x16 Parameters requestedLength:int the length of the final string Returns:String the converted string Exceptions IllegalArgumentException: if len is too large (i.e., there is not enough data in string to create a String of that length)

readUnicodeLEString

back to summary

public String readUnicodeLEString(int requestedLength)

given a byte array of 16-bit unicode characters, compress to 8-bit and return a string { 0x16, 0x00 } -0x16

Parameters

requestedLength:int: the length of the final string

Returns:String

the converted string

Exceptions

IllegalArgumentException:: if len is too large (i.e., there is not enough data in string to create a String of that length)

readUShort	back to summary
public int readUShort() Implements org.apache.poi.util.LittleEndianInput.readUShort. Reads a 16 bit, unsigned value. Annotations @Override

readUShort

back to summary

public int readUShort()

Implements org.apache.poi.util.LittleEndianInput.readUShort.

Reads a 16 bit, unsigned value.

Annotations

@Override

remaining	back to summary
public int remaining() The remaining number of bytes in the current record. Returns:int The number of bytes remaining in the current record

remaining

back to summary

public int remaining()

The remaining number of bytes in the current record.

Returns:int: The number of bytes remaining in the current record

reset back to summary

reset	back to summary
public void reset() throws IOException Resets the stream position to the previously marked position. Experimental function - this only works, when nextRecord() wasn't called in the meantime. Annotations @Internal Exceptions IOException: if marking is not supported See Also `InputStream#reset()`

public void reset() throws IOException

Resets the stream position to the previously marked position. Experimental function - this only works, when nextRecord() wasn't called in the meantime.

Annotations

@Internal

Exceptions

IOException:: if marking is not supported

See Also

InputStream#reset()

org.apache.poi.hssf.record back to summary

public final Class RecordInputStream.LeftoverDataException

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.apache.poi.hssf.record.RecordInputStream.LeftoverDataException

For use in BiffViewer which may construct Records that don't completely read all available data. This exception should never be thrown otherwise.

Constructor Summary

Access	Constructor and Description
public	LeftoverDataException(int sid, int remainingByteCount)

Method Summary

Modifier and Type	Method and Description
private static String	getRecordName(int sid)

Constructor Detail

LeftoverDataException	back to summary
public LeftoverDataException(int sid, int remainingByteCount)

Method Detail

getRecordName	back to summary
private static String getRecordName(int sid)

org.apache.poi.hssf.record back to summary

private final Class RecordInputStream.SimpleHeaderInput

Class Inheritance

extends Object
implements BiffHeaderInput

java.lang.Object
org.apache.poi.hssf.record.RecordInputStream.SimpleHeaderInput

All Implemented Interfaces

org.apache.poi.hssf.record.BiffHeaderInput

Field Summary

Modifier and Type	Field and Description
private final LittleEndianInput	_lei

Constructor Summary

Access	Constructor and Description
private	SimpleHeaderInput(LittleEndianInput lei)

Method Summary

Modifier and Type	Method and Description
public int	available() Implements org.apache.poi.hssf.record.BiffHeaderInput.available.
public int	readDataSize() Implements org.apache.poi.hssf.record.BiffHeaderInput.readDataSize. Read an unsigned short from the stream without decrypting
public int	readRecordSID() Implements org.apache.poi.hssf.record.BiffHeaderInput.readRecordSID. Read an unsigned short from the stream without decrypting