Modifier and Type	Class and Description
private static class	BZip2CompressorInputStream.Data

Field Summary

Modifier and Type	Field and Description
private BitInputStream	bin
private boolean	blockRandomised
private int	blockSize100k always: in the range 0 ..
private int	computedBlockCRC
private int	computedCombinedCRC
private final CRC	crc
private int	currentState
private BZip2CompressorInputStream.Data	data All memory intensive stuff.
private final boolean	decompressConcatenated
private static final int	EOF
private int	last Index of the last char in the block, so the block size == last + 1.
private int	nInUse
private static final int	NO_RAND_PART_A_STATE
private static final int	NO_RAND_PART_B_STATE
private static final int	NO_RAND_PART_C_STATE
private int	origPtr Index in zptr[] of original string after sorting.
private static final int	RAND_PART_A_STATE
private static final int	RAND_PART_B_STATE
private static final int	RAND_PART_C_STATE
private static final int	START_BLOCK_STATE
private int	storedBlockCRC
private int	storedCombinedCRC
private int	su_ch2
private int	su_chPrev
private int	su_count
private int	su_i2
private int	su_j2
private int	su_rNToGo
private int	su_rTPos
private int	su_tPos
private char	su_z

Constructor Summary

Access	Constructor and Description
public	BZip2CompressorInputStream(final InputStream the InputStream from which this object should be created in) Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream.
public	BZip2CompressorInputStream(final InputStream the InputStream from which this object should be created in, final boolean if true, decompress until the end of the input; if false, stop after the first .bz2 stream and leave the input position to point to the next byte after the .bz2 stream decompressConcatenated) Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream.

Access

Constructor and Description

public

BZip2CompressorInputStream(final InputStream

the InputStream from which this object should be created

in)

Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream.

public

BZip2CompressorInputStream(final InputStream

the InputStream from which this object should be created

in, final boolean

if true, decompress until the end of the input; if false, stop after the first .bz2 stream and leave the input position to point to the next byte after the .bz2 stream

decompressConcatenated)

Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream.

Method Summary

Modifier and Type	Method and Description
private static boolean	bsGetBit(final BitInputStream bin)
private static int	bsGetInt(final BitInputStream bin)
private static char	bsGetUByte(final BitInputStream bin)
private static int	Returns: the requested bits combined into an int bsR(final BitInputStream bin, final int the number of bits to read, must not exceed 32? n) read bits from the input stream
private static void	checkBounds(final int checkVal, final int limitExclusive, final String name)
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
private boolean	complete()
private void	createHuffmanDecodingTables(final int alphaSize, final int nGroups) Called by recvDecodingTables() exclusively.
private void	endBlock()
private void	getAndMoveToFrontDecode()
private int	getAndMoveToFrontDecode0()
public long	getCompressedCount() Implements org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount. Gets the amount of raw or compressed bytes read by the stream.
private static void	hbCreateDecodeTables(final int[] limit, final int[] base, final int[] perm, final char[] length, final int minLen, final int maxLen, final int alphaSize) Called by createHuffmanDecodingTables() exclusively.
private boolean	init(final boolean isFirstStream)
private void	initBlock()
private void	makeMaps()
public static boolean	Returns: true, if this stream is a bzip2 compressed stream, false otherwise matches(final byte[] the bytes to check signature, final int the number of bytes to check length) Checks if the signature matches what is expected for a bzip2 file.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(final byte[] the buffer into which the data is read. dest, final int the start offset in array `b` at which the data is written. offs, final int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
private int	read0()
private int	readNextByte(final BitInputStream in)
private void	recvDecodingTables()
private int	setupBlock()
private int	setupNoRandPartA()
private int	setupNoRandPartB()
private int	setupNoRandPartC()
private int	setupRandPartA()
private int	setupRandPartB()
private int	setupRandPartC()

Inherited from org.apache.commons.compress.compressors.CompressorInputStream:: count count getBytesRead getCount getUncompressedCount pushedBackBytes

Field Detail

bin	back to summary
private BitInputStream bin

blockRandomised	back to summary
private boolean blockRandomised

blockSize100k	back to summary
private int blockSize100k always: in the range 0 .. 9. The current block size is 100000 * this number.

computedBlockCRC	back to summary
private int computedBlockCRC

computedCombinedCRC	back to summary
private int computedCombinedCRC

crc	back to summary
private final CRC crc

currentState	back to summary
private int currentState

data	back to summary
private BZip2CompressorInputStream.Data data All memory intensive stuff. This field is initialized by initBlock().

decompressConcatenated	back to summary
private final boolean decompressConcatenated

EOF	back to summary
private static final int EOF

last	back to summary
private int last Index of the last char in the block, so the block size == last + 1.

nInUse	back to summary
private int nInUse

NO_RAND_PART_A_STATE	back to summary
private static final int NO_RAND_PART_A_STATE

NO_RAND_PART_B_STATE	back to summary
private static final int NO_RAND_PART_B_STATE

NO_RAND_PART_C_STATE	back to summary
private static final int NO_RAND_PART_C_STATE

origPtr	back to summary
private int origPtr Index in zptr[] of original string after sorting.

RAND_PART_A_STATE	back to summary
private static final int RAND_PART_A_STATE

RAND_PART_B_STATE	back to summary
private static final int RAND_PART_B_STATE

RAND_PART_C_STATE	back to summary
private static final int RAND_PART_C_STATE

START_BLOCK_STATE	back to summary
private static final int START_BLOCK_STATE

storedBlockCRC	back to summary
private int storedBlockCRC

storedCombinedCRC	back to summary
private int storedCombinedCRC

su_ch2	back to summary
private int su_ch2

su_chPrev	back to summary
private int su_chPrev

su_count	back to summary
private int su_count

su_i2	back to summary
private int su_i2

su_j2	back to summary
private int su_j2

su_rNToGo	back to summary
private int su_rNToGo

su_rTPos	back to summary
private int su_rTPos

su_tPos	back to summary
private int su_tPos

su_z	back to summary
private char su_z

Constructor Detail

BZip2CompressorInputStream back to summary

BZip2CompressorInputStream	back to summary
public BZip2CompressorInputStream(final InputStream in) throws IOException Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream. This doesn't support decompressing concatenated .bz2 files. Parameters in:InputStream the InputStream from which this object should be created Exceptions IOException: if the stream content is malformed or an I/O error occurs. NullPointerException: if `in == null`

public BZip2CompressorInputStream(final InputStream in) throws IOException

Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream. This doesn't support decompressing concatenated .bz2 files.

Parameters

in:InputStream: the InputStream from which this object should be created

Exceptions

IOException:: if the stream content is malformed or an I/O error occurs.
NullPointerException:: if in == null

BZip2CompressorInputStream back to summary

BZip2CompressorInputStream	back to summary
public BZip2CompressorInputStream(final InputStream in, final boolean decompressConcatenated) throws IOException Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream. Parameters in:InputStream the InputStream from which this object should be created decompressConcatenated:boolean if true, decompress until the end of the input; if false, stop after the first .bz2 stream and leave the input position to point to the next byte after the .bz2 stream Exceptions IOException: if `in == null`, the stream content is malformed, or an I/O error occurs.

public BZip2CompressorInputStream(final InputStream in, final boolean decompressConcatenated) throws IOException

Constructs a new BZip2CompressorInputStream which decompresses bytes read from the specified stream.

Parameters

in:InputStream: the InputStream from which this object should be created
decompressConcatenated:boolean: if true, decompress until the end of the input; if false, stop after the first .bz2 stream and leave the input position to point to the next byte after the .bz2 stream

Exceptions

IOException:: if in == null, the stream content is malformed, or an I/O error occurs.

Method Detail

bsGetBit	back to summary
private static boolean bsGetBit(final BitInputStream bin) throws IOException

bsGetInt	back to summary
private static int bsGetInt(final BitInputStream bin) throws IOException

bsGetUByte	back to summary
private static char bsGetUByte(final BitInputStream bin) throws IOException

bsR	back to summary
private static int bsR(final BitInputStream bin, final int n) throws IOException read bits from the input stream Parameters n:int the number of bits to read, must not exceed 32? Returns:int the requested bits combined into an int

bsR

back to summary

private static int bsR(final BitInputStream bin, final int n) throws IOException

read bits from the input stream

Parameters

n:int: the number of bits to read, must not exceed 32?

Returns:int

the requested bits combined into an int

checkBounds	back to summary
private static void checkBounds(final int checkVal, final int limitExclusive, final String name) throws IOException

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

complete	back to summary
private boolean complete() throws IOException

createHuffmanDecodingTables	back to summary
private void createHuffmanDecodingTables(final int alphaSize, final int nGroups) throws IOException Called by recvDecodingTables() exclusively.

endBlock	back to summary
private void endBlock() throws IOException

getAndMoveToFrontDecode	back to summary
private void getAndMoveToFrontDecode() throws IOException

getAndMoveToFrontDecode0	back to summary
private int getAndMoveToFrontDecode0() throws IOException

getCompressedCount	back to summary
public long getCompressedCount() Implements org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount. Doc from org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount. Gets the amount of raw or compressed bytes read by the stream. Returns:long the amount of raw or compressed bytes read by the stream. Annotations @Override Since 1.17

getCompressedCount

back to summary

public long getCompressedCount()

Implements org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount.

Doc from org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount.

Gets the amount of raw or compressed bytes read by the stream.

Returns:long

the amount of raw or compressed bytes read by the stream.

Annotations

@Override

Since

1.17

hbCreateDecodeTables	back to summary
private static void hbCreateDecodeTables(final int[] limit, final int[] base, final int[] perm, final char[] length, final int minLen, final int maxLen, final int alphaSize) throws IOException Called by createHuffmanDecodingTables() exclusively.

init	back to summary
private boolean init(final boolean isFirstStream) throws IOException

initBlock	back to summary
private void initBlock() throws IOException

makeMaps	back to summary
private void makeMaps()

matches

back to summary

public static boolean matches(final byte[] signature, final int length)

Checks if the signature matches what is expected for a bzip2 file.

Parameters

signature:byte[]: the bytes to check
length:int: the number of bytes to check

Returns:boolean

true, if this stream is a bzip2 compressed stream, false otherwise

Since

1.1

read back to summary

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

public int read(final byte[] dest, final int offs, final int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

dest:byte[]: the buffer into which the data is read.
offs:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

read0	back to summary
private int read0() throws IOException

readNextByte	back to summary
private int readNextByte(final BitInputStream in) throws IOException

recvDecodingTables	back to summary
private void recvDecodingTables() throws IOException

setupBlock	back to summary
private int setupBlock() throws IOException

setupNoRandPartA	back to summary
private int setupNoRandPartA() throws IOException

setupNoRandPartB	back to summary
private int setupNoRandPartB() throws IOException

setupNoRandPartC	back to summary
private int setupNoRandPartC() throws IOException

setupRandPartA	back to summary
private int setupRandPartA() throws IOException

setupRandPartB	back to summary
private int setupRandPartB() throws IOException

setupRandPartC	back to summary
private int setupRandPartC() throws IOException

org.apache.commons.compress.compressors.bzip2 back to summary

private final Class BZip2CompressorInputStream.Data

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream.Data

Field Summary

Modifier and Type	Field and Description
pack-priv final int[][]	base
pack-priv final int[]	cftab
pack-priv final char[]	getAndMoveToFrontDecode_yy
pack-priv final boolean[]	inUse
pack-priv final int[][]	limit
pack-priv final byte[]	ll8
pack-priv final int[]	minLens
pack-priv final int[][]	perm
pack-priv final byte[]	recvDecodingTables_pos
pack-priv final byte[]	selector
pack-priv final byte[]	selectorMtf
pack-priv final byte[]	seqToUnseq
pack-priv final char[][]	temp_charArray2d
pack-priv int[]	tt
pack-priv final int[]	unzftab Freq table collected to save a pass over the data during decompression.

Constructor Summary

Access	Constructor and Description
pack-priv	Data(final int blockSize100k)

Method Summary

Modifier and Type	Method and Description
pack-priv int[]	initTT(final int length) Initializes the `tt` array.

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

Field Detail

base	back to summary
pack-priv final int[][] base

cftab	back to summary
pack-priv final int[] cftab

getAndMoveToFrontDecode_yy	back to summary
pack-priv final char[] getAndMoveToFrontDecode_yy

inUse	back to summary
pack-priv final boolean[] inUse

limit	back to summary
pack-priv final int[][] limit

ll8	back to summary
pack-priv final byte[] ll8

minLens	back to summary
pack-priv final int[] minLens

perm	back to summary
pack-priv final int[][] perm

recvDecodingTables_pos	back to summary
pack-priv final byte[] recvDecodingTables_pos

selector	back to summary
pack-priv final byte[] selector

selectorMtf	back to summary
pack-priv final byte[] selectorMtf

seqToUnseq	back to summary
pack-priv final byte[] seqToUnseq

temp_charArray2d	back to summary
pack-priv final char[][] temp_charArray2d

tt	back to summary
pack-priv int[] tt

unzftab	back to summary
pack-priv final int[] unzftab Freq table collected to save a pass over the data during decompression.

Constructor Detail

Data	back to summary
pack-priv Data(final int blockSize100k)

Method Detail

initTT	back to summary
pack-priv int[] initTT(final int length) Initializes the `tt` array. This method is called when the required length of the array is known. I don't initialize it at construction time to avoid unnecessary memory allocation when compressing small files.

public Class BZip2CompressorInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class BZip2CompressorInputStream.Data

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail