Package org.apache.commons.compress.harmony.unpack200

Class BandSet

java.lang.Object

org.apache.commons.compress.harmony.unpack200.BandSet

Direct Known Subclasses:

AttrDefinitionBands, BcBands, ClassBands, CpBands, FileBands, IcBands, NewAttributeBands

public abstract class BandSet
extends java.lang.Object

Abstract superclass for a set of bands.

Field Summary

Fields

Modifier and Type	Field	Description
protected SegmentHeader	header	Segment header.
protected Segment	segment	Segment.

Constructor Summary

Constructors

Constructor	Description
BandSet(Segment segment)	Constructs a new instance for the given segment.

Method Summary

Modifier and Type	Method	Description
int[]	decodeBandInt(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Decodes a band and return an array of int values.
int[][]	decodeBandInt(java.lang.String name, java.io.InputStream in, BHSDCodec defaultCodec, int[] counts)	Decodes a band and return an array of int[] values.
protected java.lang.String[][]	getReferences(int[][] ints, java.lang.String[] reference)	Gets a new array of String references for the subset defined by the given ints array.
protected java.lang.String[]	getReferences(int[] ints, java.lang.String[] reference)	Gets a new array of String references for the subset defined by the given ints array.
CPClass[]	parseCPClassReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPClass.
CPNameAndType[]	parseCPDescriptorReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPNameAndType.
CPDouble[]	parseCPDoubleReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPDouble.
CPFieldRef[]	parseCPFieldRefReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPFieldRef.
CPFloat[]	parseCPFloatReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPFloat.
CPInterfaceMethodRef[]	parseCPInterfaceMethodRefReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPInterfaceMethodRef.
CPInteger[]	parseCPIntReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPInteger.
CPLong[]	parseCPLongReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPLong.
CPMethodRef[]	parseCPMethodRefReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPMethodRef.
CPUTF8[]	parseCPSignatureReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPUTF8.
protected CPUTF8[][]	parseCPSignatureReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int[] counts)	Parses an input stream into an array of array of CPUTF8.
CPString[]	parseCPStringReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPString.
CPUTF8[]	parseCPUTF8References(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count)	Parses an input stream into an array of CPUTF8.
CPUTF8[][]	parseCPUTF8References(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int[] counts)	Parses an input stream into an array of array of CPUTF8.
long[][]	parseFlags(java.lang.String name, java.io.InputStream in, int[] counts, BHSDCodec codec, boolean hasHi)	Parses an input stream into an array of flags.
long[][]	parseFlags(java.lang.String name, java.io.InputStream in, int[] counts, BHSDCodec hiCodec, BHSDCodec loCodec)	Parses an input stream into an array of flags.
long[]	parseFlags(java.lang.String name, java.io.InputStream in, int count, BHSDCodec codec, boolean hasHi)	Parses an input stream into an array of flags.
long[]	parseFlags(java.lang.String name, java.io.InputStream in, int count, BHSDCodec hiCodec, BHSDCodec loCodec)	Parses an input stream into an array of flags.
java.lang.String[][]	parseReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int[] counts, java.lang.String[] reference)	Parses count references from in, using codec to decode the values as indexes into reference (which is populated prior to this call).
java.lang.String[]	parseReferences(java.lang.String name, java.io.InputStream in, BHSDCodec codec, int count, java.lang.String[] reference)	Parses count references from in, using codec to decode the values as indexes into reference (which is populated prior to this call).
abstract void	read(java.io.InputStream inputStream)	Reads the input stream.
abstract void	unpack()	Unpacks this instance.
void	unpack(java.io.InputStream in)	Unpacks the input stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

segment

protected Segment segment

Segment.

header

protected SegmentHeader header

Segment header.

Constructor Detail

BandSet

public BandSet(Segment segment)

Constructs a new instance for the given segment.

Parameters:

segment - The segment.

Method Detail

decodeBandInt

public int[] decodeBandInt(java.lang.String name,
                           java.io.InputStream in,
                           BHSDCodec codec,
                           int count)
                    throws java.io.IOException,
                           Pack200Exception

Decodes a band and return an array of int values.

Parameters:

name - the name of the band (for logging and debugging).

in - the InputStream to decode.

codec - the default Codec for this band.

count - the number of elements to read.

Returns:

an array of decoded int values.

Throws:

java.io.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.

decodeBandInt

public int[][] decodeBandInt(java.lang.String name,
                             java.io.InputStream in,
                             BHSDCodec defaultCodec,
                             int[] counts)
                      throws java.io.IOException,
                             Pack200Exception

Decodes a band and return an array of int[] values.

Parameters:

name - the name of the band (primarily for logging/debugging purposes)

in - the InputStream to decode from

defaultCodec - the default codec for this band

counts - the numbers of elements to read for each int array within the array to be returned

Returns:

an array of decoded int[] values

Throws:

java.io.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

getReferences

protected java.lang.String[] getReferences(int[] ints,
                                           java.lang.String[] reference)

Gets a new array of String references for the subset defined by the given ints array.

Parameters:

ints - The indices into the reference array.

reference - The source array.

Returns:

a new array.

getReferences

protected java.lang.String[][] getReferences(int[][] ints,
                                             java.lang.String[] reference)

Gets a new array of String references for the subset defined by the given ints array.

Parameters:

ints - The indices into the reference array.

reference - The source array.

Returns:

a new array.

parseCPClassReferences

public CPClass[] parseCPClassReferences(java.lang.String name,
                                        java.io.InputStream in,
                                        BHSDCodec codec,
                                        int count)
                                 throws java.io.IOException,
                                        Pack200Exception

Parses an input stream into an array of CPClass.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPClass.

Throws:

java.io.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.

parseCPDescriptorReferences

public CPNameAndType[] parseCPDescriptorReferences(java.lang.String name,
                                                   java.io.InputStream in,
                                                   BHSDCodec codec,
                                                   int count)
                                            throws java.io.IOException,
                                                   Pack200Exception

Parses an input stream into an array of CPNameAndType.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPNameAndType.

Throws:

java.io.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.

parseCPDoubleReferences

public CPDouble[] parseCPDoubleReferences(java.lang.String name,
                                          java.io.InputStream in,
                                          BHSDCodec codec,
                                          int count)
                                   throws java.io.IOException,
                                          Pack200Exception

Parses an input stream into an array of CPDouble.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPDouble.

Throws:

java.io.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.

parseCPFieldRefReferences

public CPFieldRef[] parseCPFieldRefReferences(java.lang.String name,
                                              java.io.InputStream in,
                                              BHSDCodec codec,
                                              int count)
                                       throws java.io.IOException,
                                              Pack200Exception

Parses an input stream into an array of CPFieldRef.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPFieldRef.

Throws:

java.io.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.

parseCPFloatReferences

public CPFloat[] parseCPFloatReferences(java.lang.String name,
                                        java.io.InputStream in,
                                        BHSDCodec codec,
                                        int count)
                                 throws java.io.IOException,
                                        Pack200Exception

Parses an input stream into an array of CPFloat.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPFloat.

Throws:

java.io.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.

parseCPInterfaceMethodRefReferences

public CPInterfaceMethodRef[] parseCPInterfaceMethodRefReferences(java.lang.String name,
                                                                  java.io.InputStream in,
                                                                  BHSDCodec codec,
                                                                  int count)
                                                           throws java.io.IOException,
                                                                  Pack200Exception

Parses an input stream into an array of CPInterfaceMethodRef.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPInterfaceMethodRef.

Throws:

java.io.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.

parseCPIntReferences

public CPInteger[] parseCPIntReferences(java.lang.String name,
                                        java.io.InputStream in,
                                        BHSDCodec codec,
                                        int count)
                                 throws java.io.IOException,
                                        Pack200Exception

Parses an input stream into an array of CPInteger.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPInteger.

Throws:

java.io.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.

parseCPLongReferences

public CPLong[] parseCPLongReferences(java.lang.String name,
                                      java.io.InputStream in,
                                      BHSDCodec codec,
                                      int count)
                               throws java.io.IOException,
                                      Pack200Exception

Parses an input stream into an array of CPLong.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPLong.

Throws:

java.io.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.

parseCPMethodRefReferences

public CPMethodRef[] parseCPMethodRefReferences(java.lang.String name,
                                                java.io.InputStream in,
                                                BHSDCodec codec,
                                                int count)
                                         throws java.io.IOException,
                                                Pack200Exception

Parses an input stream into an array of CPMethodRef.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPMethodRef.

Throws:

java.io.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.

parseCPSignatureReferences

public CPUTF8[] parseCPSignatureReferences(java.lang.String name,
                                           java.io.InputStream in,
                                           BHSDCodec codec,
                                           int count)
                                    throws java.io.IOException,
                                           Pack200Exception

Parses an input stream into an array of CPUTF8.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPUTF8.

Throws:

java.io.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.

parseCPSignatureReferences

protected CPUTF8[][] parseCPSignatureReferences(java.lang.String name,
                                                java.io.InputStream in,
                                                BHSDCodec codec,
                                                int[] counts)
                                         throws java.io.IOException,
                                                Pack200Exception

Parses an input stream into an array of array of CPUTF8.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

counts - the number of elements to read.

Returns:

an array of array of decoded CPUTF8.

Throws:

java.io.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.

parseCPStringReferences

public CPString[] parseCPStringReferences(java.lang.String name,
                                          java.io.InputStream in,
                                          BHSDCodec codec,
                                          int count)
                                   throws java.io.IOException,
                                          Pack200Exception

Parses an input stream into an array of CPString.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPString.

Throws:

java.io.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.

parseCPUTF8References

public CPUTF8[] parseCPUTF8References(java.lang.String name,
                                      java.io.InputStream in,
                                      BHSDCodec codec,
                                      int count)
                               throws java.io.IOException,
                                      Pack200Exception

Parses an input stream into an array of CPUTF8.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

count - the number of elements to read.

Returns:

an array of decoded CPUTF8.

Throws:

java.io.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.

parseCPUTF8References

public CPUTF8[][] parseCPUTF8References(java.lang.String name,
                                        java.io.InputStream in,
                                        BHSDCodec codec,
                                        int[] counts)
                                 throws java.io.IOException,
                                        Pack200Exception

Parses an input stream into an array of array of CPUTF8.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to parse.

codec - the default BHSDCodec for this band

counts - the number of elements to read.

Returns:

an array of array of decoded CPUTF8.

Throws:

java.io.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.

parseFlags

public long[] parseFlags(java.lang.String name,
                         java.io.InputStream in,
                         int count,
                         BHSDCodec hiCodec,
                         BHSDCodec loCodec)
                  throws java.io.IOException,
                         Pack200Exception

Parses an input stream into an array of flags.

Parameters:

name - the name of the band (for logging and debugging).

in - the InputStream to decode.

count - the number of elements to read.

hiCodec - an optional codec if the high flag is on.

loCodec - the codec.

Returns:

an array of decoded long flags.

Throws:

java.io.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.

parseFlags

public long[] parseFlags(java.lang.String name,
                         java.io.InputStream in,
                         int count,
                         BHSDCodec codec,
                         boolean hasHi)
                  throws java.io.IOException,
                         Pack200Exception

Parses an input stream into an array of flags.

Parameters:

name - the name of the band (for logging and debugging).

in - the InputStream to decode.

count - the number of elements to read.

codec - the codec.

hasHi - whether to the high flag is enabled.

Returns:

an array of decoded long flags.

Throws:

java.io.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.

parseFlags

public long[][] parseFlags(java.lang.String name,
                           java.io.InputStream in,
                           int[] counts,
                           BHSDCodec hiCodec,
                           BHSDCodec loCodec)
                    throws java.io.IOException,
                           Pack200Exception

Parses an input stream into an array of flags.

Parameters:

name - the name of the band (for logging and debugging).

in - the InputStream to decode.

counts - the number of elements to read.

hiCodec - an optional codec if the high flag is on.

loCodec - the codec.

Returns:

an array of decoded long flags.

Throws:

java.io.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.

parseFlags

public long[][] parseFlags(java.lang.String name,
                           java.io.InputStream in,
                           int[] counts,
                           BHSDCodec codec,
                           boolean hasHi)
                    throws java.io.IOException,
                           Pack200Exception

Parses an input stream into an array of flags.

Parameters:

name - the name of the band (for logging and debugging).

in - the InputStream to decode.

counts - the number of elements to read.

codec - the codec.

hasHi - whether the high flag is enabnled.

Returns:

an array of decoded long flags.

Throws:

java.io.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.

parseReferences

public java.lang.String[] parseReferences(java.lang.String name,
                                          java.io.InputStream in,
                                          BHSDCodec codec,
                                          int count,
                                          java.lang.String[] reference)
                                   throws java.io.IOException,
                                          Pack200Exception

Parses count references from in, using codec to decode the values as indexes into reference (which is populated prior to this call). An exception is thrown if a decoded index falls outside the range [0..reference.length-1].

Parameters:

name - the band name

in - the input stream to read from

codec - the BHSDCodec to use for decoding

count - the number of references to decode

reference - the array of values to use for the references

Returns:

Parsed references.

Throws:

java.io.IOException - if a problem occurs during reading from the underlying stream.

Pack200Exception - if a problem occurs with an unexpected value or unsupported Codec.

parseReferences

public java.lang.String[][] parseReferences(java.lang.String name,
                                            java.io.InputStream in,
                                            BHSDCodec codec,
                                            int[] counts,
                                            java.lang.String[] reference)
                                     throws java.io.IOException,
                                            Pack200Exception

Parses count references from in, using codec to decode the values as indexes into reference (which is populated prior to this call). An exception is thrown if a decoded index falls outside the range [0..reference.length-1]. Unlike the other parseReferences, this post-processes the result into an array of results.

Parameters:

name - the name of the band (for logging and debugging).

in - the input stream to read from.

codec - the BHSDCodec to use for decoding.

counts - the numbers of references to decode for each array entry.

reference - the array of values to use for the references.

Returns:

Parsed references.

Throws:

java.io.IOException - if a problem occurs during reading from the underlying stream.

Pack200Exception - if a problem occurs with an unexpected value or unsupported Codec.

read

public abstract void read(java.io.InputStream inputStream)
                   throws java.io.IOException,
                          Pack200Exception

Reads the input stream.

Parameters:

inputStream - the stream to read.

Throws:

java.io.IOException - if a problem occurs during reading from the underlying stream.

Pack200Exception - if a problem occurs with an unexpected value or unsupported Codec.

unpack

public abstract void unpack()
                     throws java.io.IOException,
                            Pack200Exception

Unpacks this instance.

Throws:

java.io.IOException - if a problem occurs during reading from the underlying stream.

Pack200Exception - if a problem occurs with an unexpected value or unsupported Codec.

unpack

public void unpack(java.io.InputStream in)
            throws java.io.IOException,
                   Pack200Exception

Unpacks the input stream.

Parameters:

in - the stream to unpack.

Throws:

java.io.IOException - if a problem occurs during reading from the underlying stream.

Pack200Exception - if a problem occurs with an unexpected value or unsupported Codec.