Modifier and Type	Class and Description
private static class	StreamCompressor.DataOutputCompressor
private static class	StreamCompressor.OutputStreamCompressor
private static class	StreamCompressor.ScatterGatherBackingStoreCompressor
private static class	StreamCompressor.SeekableByteChannelCompressor

Modifier and Type	Field and Description
private static final int	BUFFER_SIZE
private final CRC32	crc
private final Deflater	def
private static final int	DEFLATER_BLOCK_SIZE
private final byte[]	outputBuffer
private final byte[]	readerBuf
private long	sourcePayloadLength
private long	totalWrittenToOutputStream
private long	writtenToOutputStreamForLastEntry

Access	Constructor and Description
pack-priv	StreamCompressor(final Deflater deflater)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
pack-priv static StreamCompressor	Returns: A stream compressor create(final DataOutput The DataOutput to receive output os, final Deflater The deflater to use for the compressor deflater) Creates a stream compressor with the given compression level.
public static StreamCompressor	Returns: A stream compressor create(final int The `Deflater` compression level compressionLevel, final ScatterGatherBackingStore The ScatterGatherBackingStore to receive output bs) Creates a stream compressor with the given compression level.
pack-priv static StreamCompressor	Returns: A stream compressor create(final OutputStream The stream to receive output os) Creates a stream compressor with the default compression level.
pack-priv static StreamCompressor	Returns: A stream compressor create(final OutputStream The stream to receive output os, final Deflater The deflater to use deflater) Creates a stream compressor with the given compression level.
public static StreamCompressor	Returns: A stream compressor create(final ScatterGatherBackingStore The ScatterGatherBackingStore to receive output bs) Creates a stream compressor with the default compression level.
pack-priv static StreamCompressor	Returns: A stream compressor create(final SeekableByteChannel The SeekableByteChannel to receive output os, final Deflater The deflater to use for the compressor deflater) Creates a stream compressor with the given compression level.
pack-priv void	deflate()
public void	deflate(final InputStream The source to compress source, final int The #ZipArchiveEntry compression method method) Deflate the given source using the supplied compression method
private void	deflateUntilInputIsNeeded()
pack-priv void	flushDeflater()
public long	Returns: The number of bytes read, never negative getBytesRead() Gets the number of bytes read from the source stream
public long	Returns: The number of bytes, never negative getBytesWrittenForLastEntry() The number of bytes written to the output for the last entry
public long	Returns: the crc32 getCrc32() The crc32 of the last deflated file
public long	Returns: The number of bytes, never negative getTotalBytesWritten() The total number of bytes written to the output for all files
pack-priv void	reset()
pack-priv long	Returns: the number of bytes written to the stream this time write(final byte[] the byte array to write b, final int the start position to write from offset, final int the number of bytes to write length, final int the comrpession method to use method) Writes bytes to ZIP entry.
public void	writeCounted(final byte[] data)
public void	writeCounted(final byte[] data, final int offset, final int length)
private void	writeDeflated(final byte[] b, final int offset, final int length)
protected abstract void	writeOut(byte[] data, int offset, int length)

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

Field Detail

BUFFER_SIZE	back to summary
private static final int BUFFER_SIZE

crc	back to summary
private final CRC32 crc

def	back to summary
private final Deflater def

DEFLATER_BLOCK_SIZE	back to summary
private static final int DEFLATER_BLOCK_SIZE

outputBuffer	back to summary
private final byte[] outputBuffer

readerBuf	back to summary
private final byte[] readerBuf

sourcePayloadLength	back to summary
private long sourcePayloadLength

totalWrittenToOutputStream	back to summary
private long totalWrittenToOutputStream

writtenToOutputStreamForLastEntry	back to summary
private long writtenToOutputStreamForLastEntry

Constructor Detail

StreamCompressor	back to summary
pack-priv StreamCompressor(final Deflater deflater)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

create	back to summary
pack-priv static StreamCompressor create(final DataOutput os, final Deflater deflater) Creates a stream compressor with the given compression level. Parameters os:DataOutput The DataOutput to receive output deflater:Deflater The deflater to use for the compressor Returns:StreamCompressor A stream compressor

create

back to summary

pack-priv static StreamCompressor create(final DataOutput os, final Deflater deflater)

Creates a stream compressor with the given compression level.

Parameters

os:DataOutput: The DataOutput to receive output
deflater:Deflater: The deflater to use for the compressor

Returns:StreamCompressor

A stream compressor

create back to summary

create	back to summary
public static StreamCompressor create(final int compressionLevel, final ScatterGatherBackingStore bs) Creates a stream compressor with the given compression level. Parameters compressionLevel:int The `Deflater` compression level bs:ScatterGatherBackingStore The ScatterGatherBackingStore to receive output Returns:StreamCompressor A stream compressor

public static StreamCompressor create(final int compressionLevel, final ScatterGatherBackingStore bs)

Creates a stream compressor with the given compression level.

Parameters

compressionLevel:int: The Deflater compression level
bs:ScatterGatherBackingStore: The ScatterGatherBackingStore to receive output

Returns:StreamCompressor

A stream compressor

create	back to summary
pack-priv static StreamCompressor create(final OutputStream os) Creates a stream compressor with the default compression level. Parameters os:OutputStream The stream to receive output Returns:StreamCompressor A stream compressor

create

back to summary

pack-priv static StreamCompressor create(final OutputStream os)

Creates a stream compressor with the default compression level.

Parameters

os:OutputStream: The stream to receive output

Returns:StreamCompressor

A stream compressor

create	back to summary
pack-priv static StreamCompressor create(final OutputStream os, final Deflater deflater) Creates a stream compressor with the given compression level. Parameters os:OutputStream The stream to receive output deflater:Deflater The deflater to use Returns:StreamCompressor A stream compressor

create

back to summary

pack-priv static StreamCompressor create(final OutputStream os, final Deflater deflater)

Creates a stream compressor with the given compression level.

Parameters

os:OutputStream: The stream to receive output
deflater:Deflater: The deflater to use

Returns:StreamCompressor

A stream compressor

create	back to summary
public static StreamCompressor create(final ScatterGatherBackingStore bs) Creates a stream compressor with the default compression level. Parameters bs:ScatterGatherBackingStore The ScatterGatherBackingStore to receive output Returns:StreamCompressor A stream compressor

create

back to summary

public static StreamCompressor create(final ScatterGatherBackingStore bs)

Creates a stream compressor with the default compression level.

Parameters

bs:ScatterGatherBackingStore: The ScatterGatherBackingStore to receive output

Returns:StreamCompressor

A stream compressor

create	back to summary
pack-priv static StreamCompressor create(final SeekableByteChannel os, final Deflater deflater) Creates a stream compressor with the given compression level. Parameters os:SeekableByteChannel The SeekableByteChannel to receive output deflater:Deflater The deflater to use for the compressor Returns:StreamCompressor A stream compressor Since 1.13

create

back to summary

pack-priv static StreamCompressor create(final SeekableByteChannel os, final Deflater deflater)

Creates a stream compressor with the given compression level.

Parameters

os:SeekableByteChannel: The SeekableByteChannel to receive output
deflater:Deflater: The deflater to use for the compressor

Returns:StreamCompressor

A stream compressor

Since

1.13

deflate	back to summary
pack-priv void deflate() throws IOException

deflate	back to summary
public void deflate(final InputStream source, final int method) throws IOException Deflate the given source using the supplied compression method Parameters source:InputStream The source to compress method:int The #ZipArchiveEntry compression method Exceptions IOException: When failures happen

deflate

back to summary

public void deflate(final InputStream source, final int method) throws IOException

Deflate the given source using the supplied compression method

Parameters

source:InputStream: The source to compress
method:int: The #ZipArchiveEntry compression method

Exceptions

IOException:: When failures happen

deflateUntilInputIsNeeded	back to summary
private void deflateUntilInputIsNeeded() throws IOException

flushDeflater	back to summary
pack-priv void flushDeflater() throws IOException

getBytesRead	back to summary
public long getBytesRead() Gets the number of bytes read from the source stream Returns:long The number of bytes read, never negative

getBytesRead

back to summary

public long getBytesRead()

Gets the number of bytes read from the source stream

Returns:long: The number of bytes read, never negative

getBytesWrittenForLastEntry	back to summary
public long getBytesWrittenForLastEntry() The number of bytes written to the output for the last entry Returns:long The number of bytes, never negative

getBytesWrittenForLastEntry

back to summary

public long getBytesWrittenForLastEntry()

The number of bytes written to the output for the last entry

Returns:long: The number of bytes, never negative

getCrc32	back to summary
public long getCrc32() The crc32 of the last deflated file Returns:long the crc32

getCrc32

back to summary

public long getCrc32()

The crc32 of the last deflated file

Returns:long: the crc32

getTotalBytesWritten	back to summary
public long getTotalBytesWritten() The total number of bytes written to the output for all files Returns:long The number of bytes, never negative

getTotalBytesWritten

back to summary

public long getTotalBytesWritten()

The total number of bytes written to the output for all files

Returns:long: The number of bytes, never negative

reset	back to summary
pack-priv void reset()

write	back to summary
pack-priv long write(final byte[] b, final int offset, final int length, final int method) throws IOException Writes bytes to ZIP entry. Parameters b:byte[] the byte array to write offset:int the start position to write from length:int the number of bytes to write method:int the comrpession method to use Returns:long the number of bytes written to the stream this time Exceptions IOException: on error

write

back to summary

pack-priv long write(final byte[] b, final int offset, final int length, final int method) throws IOException

Writes bytes to ZIP entry.

Parameters

b:byte[]: the byte array to write
offset:int: the start position to write from
length:int: the number of bytes to write
method:int: the comrpession method to use

Returns:long

the number of bytes written to the stream this time

Exceptions

IOException:: on error

writeCounted	back to summary
public void writeCounted(final byte[] data) throws IOException

writeCounted	back to summary
public void writeCounted(final byte[] data, final int offset, final int length) throws IOException

writeDeflated	back to summary
private void writeDeflated(final byte[] b, final int offset, final int length) throws IOException

writeOut	back to summary
protected abstract void writeOut(byte[] data, int offset, int length) throws IOException

org.apache.commons.compress.archivers.zip back to summary

private final Class StreamCompressor.DataOutputCompressor

Class Inheritance

extends StreamCompressor

java.lang.Object
org.apache.commons.compress.archivers.zip.StreamCompressor
org.apache.commons.compress.archivers.zip.StreamCompressor.DataOutputCompressor

Field Summary

Modifier and Type	Field and Description
private final DataOutput	raf

Constructor Summary

Access	Constructor and Description
pack-priv	DataOutputCompressor(final Deflater deflater, final DataOutput raf)

Method Summary

Modifier and Type	Method and Description
protected void	writeOut(final byte[] data, final int offset, final int length) Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Inherited from org.apache.commons.compress.archivers.zip.StreamCompressor:: close create create create create create create deflate deflate flushDeflater getBytesRead getBytesWrittenForLastEntry getCrc32 getTotalBytesWritten reset write writeCounted writeCounted

Field Detail

raf	back to summary
private final DataOutput raf

Constructor Detail

DataOutputCompressor	back to summary
pack-priv DataOutputCompressor(final Deflater deflater, final DataOutput raf)

Method Detail

writeOut	back to summary
protected void writeOut(final byte[] data, final int offset, final int length) throws IOException Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut. Annotations @Override

writeOut

back to summary

protected void writeOut(final byte[] data, final int offset, final int length) throws IOException

Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Annotations

@Override

org.apache.commons.compress.archivers.zip back to summary

private final Class StreamCompressor.OutputStreamCompressor

Class Inheritance

extends StreamCompressor

java.lang.Object
org.apache.commons.compress.archivers.zip.StreamCompressor
org.apache.commons.compress.archivers.zip.StreamCompressor.OutputStreamCompressor

Field Summary

Modifier and Type	Field and Description
private final OutputStream	os

Constructor Summary

Access	Constructor and Description
pack-priv	OutputStreamCompressor(final Deflater deflater, final OutputStream os)

Method Summary

Modifier and Type	Method and Description
protected void	writeOut(final byte[] data, final int offset, final int length) Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Inherited from org.apache.commons.compress.archivers.zip.StreamCompressor:: close create create create create create create deflate deflate flushDeflater getBytesRead getBytesWrittenForLastEntry getCrc32 getTotalBytesWritten reset write writeCounted writeCounted

Field Detail

os	back to summary
private final OutputStream os

Constructor Detail

OutputStreamCompressor	back to summary
pack-priv OutputStreamCompressor(final Deflater deflater, final OutputStream os)

Method Detail

writeOut	back to summary
protected void writeOut(final byte[] data, final int offset, final int length) throws IOException Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut. Annotations @Override

writeOut

back to summary

protected void writeOut(final byte[] data, final int offset, final int length) throws IOException

Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Annotations

@Override

org.apache.commons.compress.archivers.zip back to summary

private final Class StreamCompressor.ScatterGatherBackingStoreCompressor

Class Inheritance

extends StreamCompressor

java.lang.Object
org.apache.commons.compress.archivers.zip.StreamCompressor
org.apache.commons.compress.archivers.zip.StreamCompressor.ScatterGatherBackingStoreCompressor

Field Summary

Modifier and Type	Field and Description
private final ScatterGatherBackingStore	bs

Constructor Summary

Access	Constructor and Description
pack-priv	ScatterGatherBackingStoreCompressor(final Deflater deflater, final ScatterGatherBackingStore bs)

Method Summary

Modifier and Type	Method and Description
protected void	writeOut(final byte[] data, final int offset, final int length) Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Inherited from org.apache.commons.compress.archivers.zip.StreamCompressor:: close create create create create create create deflate deflate flushDeflater getBytesRead getBytesWrittenForLastEntry getCrc32 getTotalBytesWritten reset write writeCounted writeCounted

Field Detail

bs	back to summary
private final ScatterGatherBackingStore bs

Constructor Detail

ScatterGatherBackingStoreCompressor	back to summary
pack-priv ScatterGatherBackingStoreCompressor(final Deflater deflater, final ScatterGatherBackingStore bs)

Method Detail

writeOut

back to summary

protected void writeOut(final byte[] data, final int offset, final int length) throws IOException

Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Annotations

@Override

org.apache.commons.compress.archivers.zip back to summary

private final Class StreamCompressor.SeekableByteChannelCompressor

Class Inheritance

extends StreamCompressor

java.lang.Object
org.apache.commons.compress.archivers.zip.StreamCompressor
org.apache.commons.compress.archivers.zip.StreamCompressor.SeekableByteChannelCompressor

Field Summary

Modifier and Type	Field and Description
private final SeekableByteChannel	channel

Constructor Summary

Access	Constructor and Description
pack-priv	SeekableByteChannelCompressor(final Deflater deflater, final SeekableByteChannel channel)

Method Summary

Modifier and Type	Method and Description
protected void	writeOut(final byte[] data, final int offset, final int length) Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Inherited from org.apache.commons.compress.archivers.zip.StreamCompressor:: close create create create create create create deflate deflate flushDeflater getBytesRead getBytesWrittenForLastEntry getCrc32 getTotalBytesWritten reset write writeCounted writeCounted

Field Detail

channel	back to summary
private final SeekableByteChannel channel

Constructor Detail

SeekableByteChannelCompressor	back to summary
pack-priv SeekableByteChannelCompressor(final Deflater deflater, final SeekableByteChannel channel)

Method Detail

writeOut

back to summary

protected void writeOut(final byte[] data, final int offset, final int length) throws IOException

Implements abstract org.apache.commons.compress.archivers.zip.StreamCompressor.writeOut.

Annotations

@Override

public abstract Class StreamCompressor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StreamCompressor.DataOutputCompressor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StreamCompressor.OutputStreamCompressor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StreamCompressor.ScatterGatherBackingStoreCompressor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class StreamCompressor.SeekableByteChannelCompressor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail