Apache Commons Compress 1.26.0 · org.apache.commons.compress.harmony.unpack200.SegmentHeader

Field Summary

Modifier and Type	Field and Description
private int	archiveMajor
private int	archiveMinor
private long	archiveModtime
private long	archiveSize
private int	archiveSizeOffset
private int	attributeDefinitionCount
private InputStream	bandHeadersInputStream
private int	bandHeadersSize
private int	classCount
private int	cpClassCount
private int	cpDescriptorCount
private int	cpDoubleCount
private int	cpFieldCount
private int	cpFloatCount
private int	cpIMethodCount
private int	cpIntCount
private int	cpLongCount
private int	cpMethodCount
private int	cpSignatureCount
private int	cpStringCount
private int	cpUTF8Count
private int	defaultClassMajorVersion
private int	defaultClassMinorVersion
private static final byte[]	EMPTY_BYTE_ARRAY
private int	innerClassCount
private static final int[]	magic The magic header for a Pack200 Segment is 0xCAFED00D.
private int	numberOfFiles
private SegmentOptions	options
private final Segment	segment
private int	segmentsRemaining

Constructor Summary

Access	Constructor and Description
public	SegmentHeader(final Segment segment)

Method Summary

Modifier and Type	Method and Description
private int	Returns: the decoded value decodeScalar(final String the name of the scalar (primarily for logging/debugging purposes) name, final InputStream the input stream to read from in, final BHSDCodec the codec for this scalar codec) Decode a scalar from the band file.
private int[]	Returns: an array of decoded `long[]` values decodeScalar(final String the name of the scalar (primarily for logging/debugging purposes) name, final InputStream the input stream to read from in, final BHSDCodec the codec for this scalar codec, final int n) Decode a number of scalars from the band file.
public long	getArchiveModtime()
public long	getArchiveSize()
public int	getArchiveSizeOffset()
public int	getAttributeDefinitionCount()
public InputStream	Returns: the band headers input stream getBandHeadersInputStream() Obtain the band headers data as an input stream.
public int	getBandHeadersSize()
public int	getClassCount()
public int	getCpClassCount()
public int	getCpDescriptorCount()
public int	getCpDoubleCount()
public int	getCpFieldCount()
public int	getCpFloatCount()
public int	getCpIMethodCount()
public int	getCpIntCount()
public int	getCpLongCount()
public int	getCpMethodCount()
public int	getCpSignatureCount()
public int	getCpStringCount()
public int	getCpUTF8Count()
public int	getDefaultClassMajorVersion()
public int	getDefaultClassMinorVersion()
public int	getInnerClassCount()
public int	getNumberOfFiles()
public SegmentOptions	getOptions()
public int	getSegmentsRemaining()
private void	parseArchiveFileCounts(final InputStream in)
private void	parseArchiveSpecialCounts(final InputStream in)
private void	parseClassCounts(final InputStream in)
private void	parseCpCounts(final InputStream in)
public void	read(final InputStream in)
private void	setArchiveMajorVersion(final int the minor version of the archive version) Sets the major version of this archive.
private void	setArchiveMinorVersion(final int the minor version of the archive version) Sets the minor version of this archive
public void	setArchiveModtime(final long archiveModtime)
public void	setArchiveSize(final long archiveSize)
private void	setAttributeDefinitionCount(final long valuie)
private void	setBandHeadersData(final byte[] bandHeaders)
public void	setSegmentsRemaining(final long value)
public void	unpack()

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

Field Detail

archiveMajor	back to summary
private int archiveMajor

archiveMinor	back to summary
private int archiveMinor

archiveModtime	back to summary
private long archiveModtime

archiveSize	back to summary
private long archiveSize

archiveSizeOffset	back to summary
private int archiveSizeOffset

attributeDefinitionCount	back to summary
private int attributeDefinitionCount

bandHeadersInputStream	back to summary
private InputStream bandHeadersInputStream

bandHeadersSize	back to summary
private int bandHeadersSize

classCount	back to summary
private int classCount

cpClassCount	back to summary
private int cpClassCount

cpDescriptorCount	back to summary
private int cpDescriptorCount

cpDoubleCount	back to summary
private int cpDoubleCount

cpFieldCount	back to summary
private int cpFieldCount

cpFloatCount	back to summary
private int cpFloatCount

cpIMethodCount	back to summary
private int cpIMethodCount

cpIntCount	back to summary
private int cpIntCount

cpLongCount	back to summary
private int cpLongCount

cpMethodCount	back to summary
private int cpMethodCount

cpSignatureCount	back to summary
private int cpSignatureCount

cpStringCount	back to summary
private int cpStringCount

cpUTF8Count	back to summary
private int cpUTF8Count

defaultClassMajorVersion	back to summary
private int defaultClassMajorVersion

defaultClassMinorVersion	back to summary
private int defaultClassMinorVersion

EMPTY_BYTE_ARRAY	back to summary
private static final byte[] EMPTY_BYTE_ARRAY

innerClassCount	back to summary
private int innerClassCount

magic	back to summary
private static final int[] magic The magic header for a Pack200 Segment is 0xCAFED00D. I wonder where they get their inspiration from ...

numberOfFiles	back to summary
private int numberOfFiles

options	back to summary
private SegmentOptions options

segment	back to summary
private final Segment segment

segmentsRemaining	back to summary
private int segmentsRemaining

Constructor Detail

SegmentHeader	back to summary
public SegmentHeader(final Segment segment)

Method Detail

decodeScalar	back to summary
private int decodeScalar(final String name, final InputStream in, final BHSDCodec codec) throws IOException, Pack200Exception Decode a scalar from the band file. A scalar is like a band, but does not perform any band code switching. Parameters name:String the name of the scalar (primarily for logging/debugging purposes) in:InputStream the input stream to read from codec:BHSDCodec the codec for this scalar Returns:int the decoded value Exceptions IOException: if there is a problem reading from the underlying input stream Pack200Exception: if there is a problem decoding the value or that the value is invalid

decodeScalar

back to summary

private int decodeScalar(final String name, final InputStream in, final BHSDCodec codec) throws IOException, Pack200Exception

Decode a scalar from the band file. A scalar is like a band, but does not perform any band code switching.

Parameters

name:String: the name of the scalar (primarily for logging/debugging purposes)
in:InputStream: the input stream to read from
codec:BHSDCodec: the codec for this scalar

Returns:int

the decoded value

Exceptions

IOException:: if there is a problem reading from the underlying input stream
Pack200Exception:: if there is a problem decoding the value or that the value is invalid

decodeScalar back to summary

decodeScalar	back to summary
private int[] decodeScalar(final String name, final InputStream in, final BHSDCodec codec, final int n) throws IOException, Pack200Exception Decode a number of scalars from the band file. A scalar is like a band, but does not perform any band code switching. Parameters name:String the name of the scalar (primarily for logging/debugging purposes) in:InputStream the input stream to read from codec:BHSDCodec the codec for this scalar Returns:int[] an array of decoded `long[]` values Exceptions IOException: if there is a problem reading from the underlying input stream Pack200Exception: if there is a problem decoding the value or that the value is invalid

private int[] decodeScalar(final String name, final InputStream in, final BHSDCodec codec, final int n) throws IOException, Pack200Exception

Decode a number of scalars from the band file. A scalar is like a band, but does not perform any band code switching.

Parameters

name:String: the name of the scalar (primarily for logging/debugging purposes)
in:InputStream: the input stream to read from
codec:BHSDCodec: the codec for this scalar

Returns:int[]

an array of decoded long[] values

Exceptions

IOException:: if there is a problem reading from the underlying input stream
Pack200Exception:: if there is a problem decoding the value or that the value is invalid

getArchiveModtime	back to summary
public long getArchiveModtime()

getArchiveSize	back to summary
public long getArchiveSize()

getArchiveSizeOffset	back to summary
public int getArchiveSizeOffset()

getAttributeDefinitionCount	back to summary
public int getAttributeDefinitionCount()

getBandHeadersInputStream	back to summary
public InputStream getBandHeadersInputStream() Obtain the band headers data as an input stream. If no band headers are present, this will return an empty input stream to prevent any further reads taking place. Note that as a stream, data consumed from this input stream can't be re-used. Data is only read from this stream if the encoding is such that additional information needs to be decoded from the stream itself. Returns:InputStream the band headers input stream

getBandHeadersInputStream

back to summary

public InputStream getBandHeadersInputStream()

Obtain the band headers data as an input stream. If no band headers are present, this will return an empty input stream to prevent any further reads taking place. Note that as a stream, data consumed from this input stream can't be re-used. Data is only read from this stream if the encoding is such that additional information needs to be decoded from the stream itself.

Returns:InputStream: the band headers input stream

getBandHeadersSize	back to summary
public int getBandHeadersSize()

getClassCount	back to summary
public int getClassCount()

getCpClassCount	back to summary
public int getCpClassCount()

getCpDescriptorCount	back to summary
public int getCpDescriptorCount()

getCpDoubleCount	back to summary
public int getCpDoubleCount()

getCpFieldCount	back to summary
public int getCpFieldCount()

getCpFloatCount	back to summary
public int getCpFloatCount()

getCpIMethodCount	back to summary
public int getCpIMethodCount()

getCpIntCount	back to summary
public int getCpIntCount()

getCpLongCount	back to summary
public int getCpLongCount()

getCpMethodCount	back to summary
public int getCpMethodCount()

getCpSignatureCount	back to summary
public int getCpSignatureCount()

getCpStringCount	back to summary
public int getCpStringCount()

getCpUTF8Count	back to summary
public int getCpUTF8Count()

getDefaultClassMajorVersion	back to summary
public int getDefaultClassMajorVersion()

getDefaultClassMinorVersion	back to summary
public int getDefaultClassMinorVersion()

getInnerClassCount	back to summary
public int getInnerClassCount()

getNumberOfFiles	back to summary
public int getNumberOfFiles()

getOptions	back to summary
public SegmentOptions getOptions()

getSegmentsRemaining	back to summary
public int getSegmentsRemaining()

parseArchiveFileCounts	back to summary
private void parseArchiveFileCounts(final InputStream in) throws IOException, Pack200Exception

parseArchiveSpecialCounts	back to summary
private void parseArchiveSpecialCounts(final InputStream in) throws IOException, Pack200Exception

parseClassCounts	back to summary
private void parseClassCounts(final InputStream in) throws IOException, Pack200Exception

parseCpCounts	back to summary
private void parseCpCounts(final InputStream in) throws IOException, Pack200Exception

read	back to summary
public void read(final InputStream in) throws IOException, Error, Pack200Exception

setArchiveMajorVersion

back to summary

private void setArchiveMajorVersion(final int version) throws Pack200Exception

Sets the major version of this archive.

Parameters

version:int: the minor version of the archive

Exceptions

Pack200Exception:: if the major version is not 150

setArchiveMinorVersion

back to summary

private void setArchiveMinorVersion(final int version) throws Pack200Exception

Sets the minor version of this archive

Parameters

version:int: the minor version of the archive

Exceptions

Pack200Exception:: if the minor version is not 7

setArchiveModtime	back to summary
public void setArchiveModtime(final long archiveModtime)

setArchiveSize	back to summary
public void setArchiveSize(final long archiveSize)

setAttributeDefinitionCount	back to summary
private void setAttributeDefinitionCount(final long valuie)

setBandHeadersData	back to summary
private void setBandHeadersData(final byte[] bandHeaders)

setSegmentsRemaining	back to summary
public void setSegmentsRemaining(final long value)

unpack	back to summary
public void unpack()

public Class SegmentHeader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail