fixed some formatting typos
[vimdoclet.git] / sample / java.util.zip.DeflaterOutputStream.txt
blobd454e401a89fab20940b9ba1f5c201920a2bf98d
1 *java.util.zip.DeflaterOutputStream* *DeflaterOutputStream* This class implement
3 public class DeflaterOutputStream
4   extends    |java.io.FilterOutputStream|
6 |java.util.zip.DeflaterOutputStream_Description|
7 |java.util.zip.DeflaterOutputStream_Fields|
8 |java.util.zip.DeflaterOutputStream_Constructors|
9 |java.util.zip.DeflaterOutputStream_Methods|
11 ================================================================================
13 *java.util.zip.DeflaterOutputStream_Fields*
14 |byte[]_java.util.zip.DeflaterOutputStream.buf|
15 |java.util.zip.Deflater_java.util.zip.DeflaterOutputStream.def|
17 *java.util.zip.DeflaterOutputStream_Constructors*
18 |java.util.zip.DeflaterOutputStream(OutputStream)|Creates a new output stream w
19 |java.util.zip.DeflaterOutputStream(OutputStream,Deflater)|Creates a new output
20 |java.util.zip.DeflaterOutputStream(OutputStream,Deflater,int)|Creates a new ou
22 *java.util.zip.DeflaterOutputStream_Methods*
23 |java.util.zip.DeflaterOutputStream.close()|Writes remaining compressed data to
24 |java.util.zip.DeflaterOutputStream.deflate()|Writes next block of compressed d
25 |java.util.zip.DeflaterOutputStream.finish()|Finishes writing compressed data t
26 |java.util.zip.DeflaterOutputStream.write(byte[],int,int)|Writes an array of by
27 |java.util.zip.DeflaterOutputStream.write(int)|Writes a byte to the compressed 
29 *java.util.zip.DeflaterOutputStream_Description*
31 This class implements an output stream filter for compressing data in the 
32 "deflate" compression format. It is also used as the basis for other types of 
33 compression filters, such as GZIPOutputStream. 
37 *byte[]_java.util.zip.DeflaterOutputStream.buf*
39 Output buffer for writing compressed data. 
42 *java.util.zip.Deflater_java.util.zip.DeflaterOutputStream.def*
44 Compressor for this stream. 
48 *java.util.zip.DeflaterOutputStream(OutputStream)*
50 public DeflaterOutputStream(java.io.OutputStream out)
52 Creates a new output stream with a default compressor and buffer size. 
54     out - the output stream 
56 *java.util.zip.DeflaterOutputStream(OutputStream,Deflater)*
58 public DeflaterOutputStream(
59   java.io.OutputStream out,
60   java.util.zip.Deflater def)
62 Creates a new output stream with the specified compressor and a default buffer 
63 size. 
65     out - the output stream 
66     def - the compressor ("deflater") 
68 *java.util.zip.DeflaterOutputStream(OutputStream,Deflater,int)*
70 public DeflaterOutputStream(
71   java.io.OutputStream out,
72   java.util.zip.Deflater def,
73   int size)
75 Creates a new output stream with the specified compressor and buffer size. 
77     out - the output stream 
78     def - the compressor ("deflater") 
79     size - the output buffer size 
81 *java.util.zip.DeflaterOutputStream.close()*
83 public void close()
84   throws |java.io.IOException|
85          
86 Writes remaining compressed data to the output stream and closes the underlying 
87 stream. 
91 *java.util.zip.DeflaterOutputStream.deflate()*
93 protected void deflate()
94   throws |java.io.IOException|
95          
96 Writes next block of compressed data to the output stream. 
100 *java.util.zip.DeflaterOutputStream.finish()*
102 public void finish()
103   throws |java.io.IOException|
104          
105 Finishes writing compressed data to the output stream without closing the 
106 underlying stream. Use this method when applying multiple filters in succession 
107 to the same output stream. 
111 *java.util.zip.DeflaterOutputStream.write(byte[],int,int)*
113 public void write(
114   byte[] b,
115   int off,
116   int len)
117   throws |java.io.IOException|
118          
119 Writes an array of bytes to the compressed output stream. This method will 
120 block until all the bytes are written. 
123     b - the data to be written 
124     off - the start offset of the data 
125     len - the length of the data 
127 *java.util.zip.DeflaterOutputStream.write(int)*
129 public void write(int b)
130   throws |java.io.IOException|
131          
132 Writes a byte to the compressed output stream. This method will block until the 
133 byte can be written. 
136     b - the byte to be written