Top Description Fields Constructors Methods
com.ning.compress.gzip

public Class OptimizedGZIPOutputStream

extends OutputStream
Class Inheritance
Imports
java.io.*, java.util.zip.CRC32, .Deflater, .DeflaterOutputStream

Optimized variant of java.util.zip.GZIPOutputStream that reuses underlying java.util.zip.Deflater instance}.

Field Summary

Modifier and TypeField and Description
protected CRC32
protected Deflater
protected DeflaterOutputStream
protected final byte[]
protected final GZIPRecycler
protected OutputStream
_rawOut

Underlying output stream that header, compressed content and footer go to

pack-priv static final byte[]
DEFAULT_HEADER

For now, static header seems fine, since JDK default gzip writer does it too:

private static final int
GZIP_MAGIC

GZIP header magic number; written out LSB like most everything else (i.e. as 0x1f 0x8b)

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private static final void
_putInt(byte[] buf, int offset, int value)

Stupid GZIP, writes stuff in wrong order (not network, but x86)

private void
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.
public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream and forces any buffered output bytes to be written out.
public final void
write(byte[]
the data.
buf
)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.
public final void
write(int
the byte.
c
)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.
public void
write(byte[]
the data.
buf
,
int
the start offset in the data.
off
,
int
the number of bytes to write.
len
)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.
Inherited from java.io.OutputStream:
nullOutputStream

Field Detail

_crcback to summary
protected CRC32 _crc
_deflaterback to summary
protected Deflater _deflater
_deflaterOutback to summary
protected DeflaterOutputStream _deflaterOut
_eightByteBufferback to summary
protected final byte[] _eightByteBuffer
_gzipRecyclerback to summary
protected final GZIPRecycler _gzipRecycler
_rawOutback to summary
protected OutputStream _rawOut

Underlying output stream that header, compressed content and footer go to

DEFAULT_HEADERback to summary
pack-priv static final byte[] DEFAULT_HEADER

For now, static header seems fine, since JDK default gzip writer does it too:

GZIP_MAGICback to summary
private static final int GZIP_MAGIC

GZIP header magic number; written out LSB like most everything else (i.e. as 0x1f 0x8b)

Constructor Detail

OptimizedGZIPOutputStreamback to summary
public OptimizedGZIPOutputStream(OutputStream out) throws IOException

Method Detail

_putIntback to summary
private static final void _putInt(byte[] buf, int offset, int value)

Stupid GZIP, writes stuff in wrong order (not network, but x86)

_writeTrailerback to summary
private void _writeTrailer(OutputStream out) throws IOException
closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
flushback to summary
public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public final void write(byte[] buf) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters
buf:byte[]

the data.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public final void write(int c) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
c:int

the byte.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(byte[] buf, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
buf:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.