Package org.apache.poi.hssf.record
Class RecordInputStream
java.lang.Object
org.apache.poi.hssf.record.RecordInputStream
- All Implemented Interfaces:
LittleEndianInput
Title: Record Input Stream
Description: Wraps a stream and provides helper methods for the construction of records.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
For use inBiffViewer
which may constructRecord
s that don't completely read all available data. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
Maximum size of a single record (minus the 4 byte header) without a continue -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
int
short
getSid()
boolean
Note - this method is expected to be called only when completed reading the current BIFF record.void
mark
(int readlimit) Mark the stream position - experimental functionvoid
Moves to the next record in the stream.int
read
(byte[] b, int off, int len) byte[]
Deprecated.POI 2.0 Best to write a input stream that wraps this one where there is special sub record that may overlap continue records.byte
readByte()
Reads an 8 bit, signed valuereadCompressedUnicode
(int requestedLength) double
void
readFully
(byte[] buf) void
readFully
(byte[] buf, int off, int len) protected void
readFully
(byte[] buf, int off, int len, boolean isPlain) int
readInt()
Reads a 32 bit, signed valuelong
readLong()
Reads a 64 bit, signed valuevoid
readPlain
(byte[] buf, int off, int len) Usually acts the same asLittleEndianInput.readFully(byte[], int, int)
, but for an encrypted stream the raw (unencrypted) data is filledbyte[]
Returns the remaining bytes for the current record.short
Reads a 16 bit, signed valueint
Reads an 8 bit, unsigned valuereadUnicodeLEString
(int requestedLength) given a byte array of 16-bit unicode characters, compress to 8-bit and return a string { 0x16, 0x00 } -0x16int
Reads a 16 bit, unsigned value.int
The remaining number of bytes in the current record.void
reset()
Resets the stream position to the previously marked position.
-
Field Details
-
MAX_RECORD_DATA_SIZE
public static final short MAX_RECORD_DATA_SIZEMaximum size of a single record (minus the 4 byte header) without a continue- See Also:
-
-
Constructor Details
-
RecordInputStream
- Throws:
RecordFormatException
-
RecordInputStream
public RecordInputStream(InputStream in, EncryptionInfo key, int initialOffset) throws RecordFormatException - Throws:
RecordFormatException
-
-
Method Details
-
available
public int available()- Specified by:
available
in interfaceLittleEndianInput
- Returns:
- the number of bytes available in the current BIFF record
- See Also:
-
read
public int read(byte[] b, int off, int len) -
getSid
public short getSid() -
hasNextRecord
Note - this method is expected to be called only when completed reading the current BIFF record.- Returns:
- true, if there's another record in the stream
- Throws:
RecordInputStream.LeftoverDataException
- if this method is called before reaching the end of the current record.
-
nextRecord
Moves to the next record in the stream. Note: The auto continue flag is reset to true- Throws:
RecordFormatException
-
readByte
public byte readByte()Reads an 8 bit, signed value- Specified by:
readByte
in interfaceLittleEndianInput
-
readShort
public short readShort()Reads a 16 bit, signed value- Specified by:
readShort
in interfaceLittleEndianInput
-
readInt
public int readInt()Reads a 32 bit, signed value- Specified by:
readInt
in interfaceLittleEndianInput
-
readLong
public long readLong()Reads a 64 bit, signed value- Specified by:
readLong
in interfaceLittleEndianInput
-
readUByte
public int readUByte()Reads an 8 bit, unsigned value- Specified by:
readUByte
in interfaceLittleEndianInput
-
readUShort
public int readUShort()Reads a 16 bit, unsigned value.- Specified by:
readUShort
in interfaceLittleEndianInput
-
readDouble
public double readDouble()- Specified by:
readDouble
in interfaceLittleEndianInput
-
readPlain
public void readPlain(byte[] buf, int off, int len) Description copied from interface:LittleEndianInput
Usually acts the same asLittleEndianInput.readFully(byte[], int, int)
, but for an encrypted stream the raw (unencrypted) data is filled- Specified by:
readPlain
in interfaceLittleEndianInput
- Parameters:
buf
- the byte array to receive the bytesoff
- the start offset into the byte arraylen
- the amount of bytes to fill
-
readFully
public void readFully(byte[] buf) - Specified by:
readFully
in interfaceLittleEndianInput
-
readFully
public void readFully(byte[] buf, int off, int len) - Specified by:
readFully
in interfaceLittleEndianInput
-
readFully
protected void readFully(byte[] buf, int off, int len, boolean isPlain) -
readString
-
readUnicodeLEString
given a byte array of 16-bit unicode characters, compress to 8-bit and return a string { 0x16, 0x00 } -0x16- Parameters:
requestedLength
- the length of the final string- Returns:
- the converted string
- Throws:
IllegalArgumentException
- if len is too large (i.e., there is not enough data in string to create a String of that length)
-
readCompressedUnicode
-
readRemainder
public byte[] readRemainder()Returns the remaining bytes for the current record.- Returns:
- The remaining bytes of the current record.
-
readAllContinuedRemainder
Deprecated.POI 2.0 Best to write a 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:
- all byte data for the current record
-
remaining
public int remaining()The remaining number of bytes in the current record.- Returns:
- The number of bytes remaining in the current record
-
getNextSid
public int getNextSid()- Returns:
- sid of next record. Can be called after hasNextRecord()
-
mark
Mark the stream position - experimental function- Parameters:
readlimit
- the read ahead limit- See Also:
-
reset
Resets the stream position to the previously marked position. Experimental function - this only works, when nextRecord() wasn't called in the meantime.- Throws:
IOException
- if marking is not supported- See Also:
-