- java.lang.Object
-
- java.io.OutputStream
-
- java.io.FilterOutputStream
-
- java.util.zip.DeflaterOutputStream
-
- All Implemented Interfaces:
- Closeable, Flushable, AutoCloseable
- Direct Known Subclasses:
- GZIPOutputStream, ZipOutputStream
public class DeflaterOutputStream extends FilterOutputStream
This class implements an output stream filter for compressing data in the "deflate" compression format. It is also used as the basis for other types of compression filters, such as GZIPOutputStream.- See Also:
Deflater
-
-
Field Summary
Fields Modifier and Type Field and Description protected byte[]
buf
Output buffer for writing compressed data.protected Deflater
def
Compressor for this stream.-
Fields inherited from class java.io.FilterOutputStream
out
-
-
Constructor Summary
Constructors Constructor and Description DeflaterOutputStream(OutputStream out)
Creates a new output stream with a default compressor and buffer size.DeflaterOutputStream(OutputStream out, boolean syncFlush)
Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.DeflaterOutputStream(OutputStream out, Deflater def)
Creates a new output stream with the specified compressor and a default buffer size.DeflaterOutputStream(OutputStream out, Deflater def, boolean syncFlush)
Creates a new output stream with the specified compressor, flush mode and a default buffer size.DeflaterOutputStream(OutputStream out, Deflater def, int size)
Creates a new output stream with the specified compressor and buffer size.DeflaterOutputStream(OutputStream out, Deflater def, int size, boolean syncFlush)
Creates a new output stream with the specified compressor, buffer size and flush mode.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Writes remaining compressed data to the output stream and closes the underlying stream.protected void
deflate()
Writes next block of compressed data to the output stream.void
finish()
Finishes writing compressed data to the output stream without closing the underlying stream.void
flush()
Flushes the compressed output stream.void
write(byte[] b, int off, int len)
Writes an array of bytes to the compressed output stream.void
write(int b)
Writes a byte to the compressed output stream.-
Methods inherited from class java.io.FilterOutputStream
write
-
-
-
-
Field Detail
-
def
protected Deflater def
Compressor for this stream.
-
buf
protected byte[] buf
Output buffer for writing compressed data.
-
-
Constructor Detail
-
DeflaterOutputStream
public DeflaterOutputStream(OutputStream out, Deflater def, int size, boolean syncFlush)
Creates a new output stream with the specified compressor, buffer size and flush mode.- Parameters:
out
- the output streamdef
- the compressor ("deflater")size
- the output buffer sizesyncFlush
- iftrue
theflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Throws:
IllegalArgumentException
- if size is <= 0- Since:
- 1.7
-
DeflaterOutputStream
public DeflaterOutputStream(OutputStream out, Deflater def, int size)
Creates a new output stream with the specified compressor and buffer size.The new output stream instance is created as if by invoking the 4-argument constructor DeflaterOutputStream(out, def, size, false).
- Parameters:
out
- the output streamdef
- the compressor ("deflater")size
- the output buffer size- Throws:
IllegalArgumentException
- if size is <= 0
-
DeflaterOutputStream
public DeflaterOutputStream(OutputStream out, Deflater def, boolean syncFlush)
Creates a new output stream with the specified compressor, flush mode and a default buffer size.- Parameters:
out
- the output streamdef
- the compressor ("deflater")syncFlush
- iftrue
theflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Since:
- 1.7
-
DeflaterOutputStream
public DeflaterOutputStream(OutputStream out, Deflater def)
Creates a new output stream with the specified compressor and a default buffer size.The new output stream instance is created as if by invoking the 3-argument constructor DeflaterOutputStream(out, def, false).
- Parameters:
out
- the output streamdef
- the compressor ("deflater")
-
DeflaterOutputStream
public DeflaterOutputStream(OutputStream out, boolean syncFlush)
Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.- Parameters:
out
- the output streamsyncFlush
- iftrue
theflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Since:
- 1.7
-
DeflaterOutputStream
public DeflaterOutputStream(OutputStream out)
Creates a new output stream with a default compressor and buffer size.The new output stream instance is created as if by invoking the 2-argument constructor DeflaterOutputStream(out, false).
- Parameters:
out
- the output stream
-
-
Method Detail
-
write
public void write(int b) throws IOException
Writes a byte to the compressed output stream. This method will block until the byte can be written.- Overrides:
write
in classFilterOutputStream
- Parameters:
b
- the byte to be written- Throws:
IOException
- if an I/O error has occurred
-
write
public void write(byte[] b, int off, int len) throws IOException
Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written.- Overrides:
write
in classFilterOutputStream
- Parameters:
b
- the data to be writtenoff
- the start offset of the datalen
- the length of the data- Throws:
IOException
- if an I/O error has occurred- See Also:
FilterOutputStream.write(int)
-
finish
public void finish() throws IOException
Finishes writing compressed data to the output stream without closing the underlying stream. Use this method when applying multiple filters in succession to the same output stream.- Throws:
IOException
- if an I/O error has occurred
-
close
public void close() throws IOException
Writes remaining compressed data to the output stream and closes the underlying stream.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classFilterOutputStream
- Throws:
IOException
- if an I/O error has occurred- See Also:
FilterOutputStream.flush()
,FilterOutputStream.out
-
deflate
protected void deflate() throws IOException
Writes next block of compressed data to the output stream.- Throws:
IOException
- if an I/O error has occurred
-
flush
public void flush() throws IOException
Flushes the compressed output stream. IfsyncFlush
istrue
when this compressed output stream is constructed, this method first flushes the underlyingcompressor
with the flush modeDeflater.SYNC_FLUSH
to force all pending data to be flushed out to the output stream and then flushes the output stream. Otherwise this method only flushes the output stream without flushing thecompressor
.- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classFilterOutputStream
- Throws:
IOException
- if an I/O error has occurred- Since:
- 1.7
- See Also:
FilterOutputStream.out
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 14:38:51 Cette version de la page est en cache (à la date du 22/12/2024 14:38:51) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/util/zip/deflateroutputstream.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.