Improved build.xml
[vimdoclet.git] / sample / java.util.zip.DeflaterOutputStream.txt
blob99a1b8f442839e521dfe0cf5ffae93a040a7444f
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. 
36 *byte[]_java.util.zip.DeflaterOutputStream.buf*
38 This class implements an output stream filter for compressing data in the 
39 "deflate" compression format. It is also used as the basis for other types of 
40 compression filters, such as GZIPOutputStream. 
43 *java.util.zip.Deflater_java.util.zip.DeflaterOutputStream.def*
45 This class implements an output stream filter for compressing data in the 
46 "deflate" compression format. It is also used as the basis for other types of 
47 compression filters, such as GZIPOutputStream. 
51 *java.util.zip.DeflaterOutputStream(OutputStream)*
53 public DeflaterOutputStream(java.io.OutputStream out)
55 Creates a new output stream with a default compressor and buffer size. 
57     out - the output stream 
59 *java.util.zip.DeflaterOutputStream(OutputStream,Deflater)*
61 public DeflaterOutputStream(
62   java.io.OutputStream out,
63   java.util.zip.Deflater def)
65 Creates a new output stream with the specified compressor and a default buffer 
66 size. 
68     out - the output stream 
69     def - the compressor ("deflater") 
71 *java.util.zip.DeflaterOutputStream(OutputStream,Deflater,int)*
73 public DeflaterOutputStream(
74   java.io.OutputStream out,
75   java.util.zip.Deflater def,
76   int size)
78 Creates a new output stream with the specified compressor and buffer size. 
80     out - the output stream 
81     def - the compressor ("deflater") 
82     size - the output buffer size 
84 *java.util.zip.DeflaterOutputStream.close()*
86 public void close()
87   throws |java.io.IOException|
88          
89 Writes remaining compressed data to the output stream and closes the underlying 
90 stream. 
93 *java.util.zip.DeflaterOutputStream.deflate()*
95 protected void deflate()
96   throws |java.io.IOException|
97          
98 Writes next block of compressed data to the output stream. 
101 *java.util.zip.DeflaterOutputStream.finish()*
103 public void finish()
104   throws |java.io.IOException|
105          
106 Finishes writing compressed data to the output stream without closing the 
107 underlying stream. Use this method when applying multiple filters in succession 
108 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. 
122     b - the data to be written 
123     off - the start offset of the data 
124     len - the length of the data 
126 *java.util.zip.DeflaterOutputStream.write(int)*
128 public void write(int b)
129   throws |java.io.IOException|
130          
131 Writes a byte to the compressed output stream. This method will block until the 
132 byte can be written. 
134     b - the byte to be written