[120] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
---|
| 2 | <!--NewPage--> |
---|
| 3 | <HTML> |
---|
| 4 | <HEAD> |
---|
| 5 | <!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:53 UTC 2009 --> |
---|
| 6 | <TITLE> |
---|
| 7 | ZlibCompressor (Hadoop 0.20.1 API) |
---|
| 8 | </TITLE> |
---|
| 9 | |
---|
| 10 | <META NAME="date" CONTENT="2009-09-01"> |
---|
| 11 | |
---|
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
---|
| 13 | |
---|
| 14 | <SCRIPT type="text/javascript"> |
---|
| 15 | function windowTitle() |
---|
| 16 | { |
---|
| 17 | if (location.href.indexOf('is-external=true') == -1) { |
---|
| 18 | parent.document.title="ZlibCompressor (Hadoop 0.20.1 API)"; |
---|
| 19 | } |
---|
| 20 | } |
---|
| 21 | </SCRIPT> |
---|
| 22 | <NOSCRIPT> |
---|
| 23 | </NOSCRIPT> |
---|
| 24 | |
---|
| 25 | </HEAD> |
---|
| 26 | |
---|
| 27 | <BODY BGCOLOR="white" onload="windowTitle();"> |
---|
| 28 | <HR> |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | <!-- ========= START OF TOP NAVBAR ======= --> |
---|
| 32 | <A NAME="navbar_top"><!-- --></A> |
---|
| 33 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
---|
| 34 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 35 | <TR> |
---|
| 36 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 37 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
| 38 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 39 | <TR ALIGN="center" VALIGN="top"> |
---|
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 42 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ZlibCompressor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 48 | </TR> |
---|
| 49 | </TABLE> |
---|
| 50 | </TD> |
---|
| 51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 52 | </EM> |
---|
| 53 | </TD> |
---|
| 54 | </TR> |
---|
| 55 | |
---|
| 56 | <TR> |
---|
| 57 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 58 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/BuiltInZlibInflater.html" title="class in org.apache.hadoop.io.compress.zlib"><B>PREV CLASS</B></A> |
---|
| 59 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 61 | <A HREF="../../../../../../index.html?org/apache/hadoop/io/compress/zlib/ZlibCompressor.html" target="_top"><B>FRAMES</B></A> |
---|
| 62 | <A HREF="ZlibCompressor.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 63 | <SCRIPT type="text/javascript"> |
---|
| 64 | <!-- |
---|
| 65 | if(window==top) { |
---|
| 66 | document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 67 | } |
---|
| 68 | //--> |
---|
| 69 | </SCRIPT> |
---|
| 70 | <NOSCRIPT> |
---|
| 71 | <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 72 | </NOSCRIPT> |
---|
| 73 | |
---|
| 74 | |
---|
| 75 | </FONT></TD> |
---|
| 76 | </TR> |
---|
| 77 | <TR> |
---|
| 78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 79 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 81 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 82 | </TR> |
---|
| 83 | </TABLE> |
---|
| 84 | <A NAME="skip-navbar_top"></A> |
---|
| 85 | <!-- ========= END OF TOP NAVBAR ========= --> |
---|
| 86 | |
---|
| 87 | <HR> |
---|
| 88 | <!-- ======== START OF CLASS DATA ======== --> |
---|
| 89 | <H2> |
---|
| 90 | <FONT SIZE="-1"> |
---|
| 91 | org.apache.hadoop.io.compress.zlib</FONT> |
---|
| 92 | <BR> |
---|
| 93 | Class ZlibCompressor</H2> |
---|
| 94 | <PRE> |
---|
| 95 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
---|
| 96 | <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.io.compress.zlib.ZlibCompressor</B> |
---|
| 97 | </PRE> |
---|
| 98 | <DL> |
---|
| 99 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></DD> |
---|
| 100 | </DL> |
---|
| 101 | <HR> |
---|
| 102 | <DL> |
---|
| 103 | <DT><PRE>public class <B>ZlibCompressor</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></DL> |
---|
| 104 | </PRE> |
---|
| 105 | |
---|
| 106 | <P> |
---|
| 107 | A <A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A> based on the popular |
---|
| 108 | zlib compression algorithm. |
---|
| 109 | http://www.zlib.net/ |
---|
| 110 | <P> |
---|
| 111 | |
---|
| 112 | <P> |
---|
| 113 | <HR> |
---|
| 114 | |
---|
| 115 | <P> |
---|
| 116 | <!-- ======== NESTED CLASS SUMMARY ======== --> |
---|
| 117 | |
---|
| 118 | <A NAME="nested_class_summary"><!-- --></A> |
---|
| 119 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 120 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 121 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 122 | <B>Nested Class Summary</B></FONT></TH> |
---|
| 123 | </TR> |
---|
| 124 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 125 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 126 | <CODE>static class</CODE></FONT></TD> |
---|
| 127 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionHeader</A></B></CODE> |
---|
| 128 | |
---|
| 129 | <BR> |
---|
| 130 | The type of header for compressed data.</TD> |
---|
| 131 | </TR> |
---|
| 132 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 133 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 134 | <CODE>static class</CODE></FONT></TD> |
---|
| 135 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionLevel.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionLevel</A></B></CODE> |
---|
| 136 | |
---|
| 137 | <BR> |
---|
| 138 | The compression level for zlib library.</TD> |
---|
| 139 | </TR> |
---|
| 140 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 141 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 142 | <CODE>static class</CODE></FONT></TD> |
---|
| 143 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionStrategy.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionStrategy</A></B></CODE> |
---|
| 144 | |
---|
| 145 | <BR> |
---|
| 146 | The compression level for zlib library.</TD> |
---|
| 147 | </TR> |
---|
| 148 | </TABLE> |
---|
| 149 | |
---|
| 150 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 151 | |
---|
| 152 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 153 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 154 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 155 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 156 | <B>Constructor Summary</B></FONT></TH> |
---|
| 157 | </TR> |
---|
| 158 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 159 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#ZlibCompressor()">ZlibCompressor</A></B>()</CODE> |
---|
| 160 | |
---|
| 161 | <BR> |
---|
| 162 | Creates a new compressor with the default compression level.</TD> |
---|
| 163 | </TR> |
---|
| 164 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 165 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#ZlibCompressor(org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel, org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy, org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader, int)">ZlibCompressor</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionLevel.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionLevel</A> level, |
---|
| 166 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionStrategy.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionStrategy</A> strategy, |
---|
| 167 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionHeader</A> header, |
---|
| 168 | int directBufferSize)</CODE> |
---|
| 169 | |
---|
| 170 | <BR> |
---|
| 171 | Creates a new compressor using the specified compression level.</TD> |
---|
| 172 | </TR> |
---|
| 173 | </TABLE> |
---|
| 174 | |
---|
| 175 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 176 | |
---|
| 177 | <A NAME="method_summary"><!-- --></A> |
---|
| 178 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 179 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 180 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 181 | <B>Method Summary</B></FONT></TH> |
---|
| 182 | </TR> |
---|
| 183 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 184 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 185 | <CODE> int</CODE></FONT></TD> |
---|
| 186 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#compress(byte[], int, int)">compress</A></B>(byte[] b, |
---|
| 187 | int off, |
---|
| 188 | int len)</CODE> |
---|
| 189 | |
---|
| 190 | <BR> |
---|
| 191 | Fills specified buffer with compressed data.</TD> |
---|
| 192 | </TR> |
---|
| 193 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 195 | <CODE> void</CODE></FONT></TD> |
---|
| 196 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#end()">end</A></B>()</CODE> |
---|
| 197 | |
---|
| 198 | <BR> |
---|
| 199 | Closes the compressor and discards any unprocessed input.</TD> |
---|
| 200 | </TR> |
---|
| 201 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 202 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 203 | <CODE> void</CODE></FONT></TD> |
---|
| 204 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#finish()">finish</A></B>()</CODE> |
---|
| 205 | |
---|
| 206 | <BR> |
---|
| 207 | When called, indicates that compression should end |
---|
| 208 | with the current contents of the input buffer.</TD> |
---|
| 209 | </TR> |
---|
| 210 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 211 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 212 | <CODE> boolean</CODE></FONT></TD> |
---|
| 213 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#finished()">finished</A></B>()</CODE> |
---|
| 214 | |
---|
| 215 | <BR> |
---|
| 216 | Returns true if the end of the compressed |
---|
| 217 | data output stream has been reached.</TD> |
---|
| 218 | </TR> |
---|
| 219 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 220 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 221 | <CODE> long</CODE></FONT></TD> |
---|
| 222 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#getBytesRead()">getBytesRead</A></B>()</CODE> |
---|
| 223 | |
---|
| 224 | <BR> |
---|
| 225 | Returns the total number of uncompressed bytes input so far.</TD> |
---|
| 226 | </TR> |
---|
| 227 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 228 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 229 | <CODE> long</CODE></FONT></TD> |
---|
| 230 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#getBytesWritten()">getBytesWritten</A></B>()</CODE> |
---|
| 231 | |
---|
| 232 | <BR> |
---|
| 233 | Returns the total number of compressed bytes output so far.</TD> |
---|
| 234 | </TR> |
---|
| 235 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 236 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 237 | <CODE> boolean</CODE></FONT></TD> |
---|
| 238 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#needsInput()">needsInput</A></B>()</CODE> |
---|
| 239 | |
---|
| 240 | <BR> |
---|
| 241 | Returns true if the input data buffer is empty and |
---|
| 242 | #setInput() should be called to provide more input.</TD> |
---|
| 243 | </TR> |
---|
| 244 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 245 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 246 | <CODE> void</CODE></FONT></TD> |
---|
| 247 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#reset()">reset</A></B>()</CODE> |
---|
| 248 | |
---|
| 249 | <BR> |
---|
| 250 | Resets compressor so that a new set of input data can be processed.</TD> |
---|
| 251 | </TR> |
---|
| 252 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 253 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 254 | <CODE> void</CODE></FONT></TD> |
---|
| 255 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#setDictionary(byte[], int, int)">setDictionary</A></B>(byte[] b, |
---|
| 256 | int off, |
---|
| 257 | int len)</CODE> |
---|
| 258 | |
---|
| 259 | <BR> |
---|
| 260 | Sets preset dictionary for compression.</TD> |
---|
| 261 | </TR> |
---|
| 262 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 263 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 264 | <CODE> void</CODE></FONT></TD> |
---|
| 265 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.html#setInput(byte[], int, int)">setInput</A></B>(byte[] b, |
---|
| 266 | int off, |
---|
| 267 | int len)</CODE> |
---|
| 268 | |
---|
| 269 | <BR> |
---|
| 270 | Sets input data for compression.</TD> |
---|
| 271 | </TR> |
---|
| 272 | </TABLE> |
---|
| 273 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 274 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 275 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 276 | <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
---|
| 277 | </TR> |
---|
| 278 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 279 | <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
---|
| 280 | </TR> |
---|
| 281 | </TABLE> |
---|
| 282 | |
---|
| 283 | <P> |
---|
| 284 | |
---|
| 285 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 286 | |
---|
| 287 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 288 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 289 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 290 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 291 | <B>Constructor Detail</B></FONT></TH> |
---|
| 292 | </TR> |
---|
| 293 | </TABLE> |
---|
| 294 | |
---|
| 295 | <A NAME="ZlibCompressor(org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel, org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy, org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader, int)"><!-- --></A><H3> |
---|
| 296 | ZlibCompressor</H3> |
---|
| 297 | <PRE> |
---|
| 298 | public <B>ZlibCompressor</B>(<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionLevel.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionLevel</A> level, |
---|
| 299 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionStrategy.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionStrategy</A> strategy, |
---|
| 300 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibCompressor.CompressionHeader</A> header, |
---|
| 301 | int directBufferSize)</PRE> |
---|
| 302 | <DL> |
---|
| 303 | <DD>Creates a new compressor using the specified compression level. |
---|
| 304 | Compressed data will be generated in ZLIB format. |
---|
| 305 | <P> |
---|
| 306 | <DL> |
---|
| 307 | <DT><B>Parameters:</B><DD><CODE>level</CODE> - Compression level #CompressionLevel<DD><CODE>strategy</CODE> - Compression strategy #CompressionStrategy<DD><CODE>header</CODE> - Compression header #CompressionHeader<DD><CODE>directBufferSize</CODE> - Size of the direct buffer to be used.</DL> |
---|
| 308 | </DL> |
---|
| 309 | <HR> |
---|
| 310 | |
---|
| 311 | <A NAME="ZlibCompressor()"><!-- --></A><H3> |
---|
| 312 | ZlibCompressor</H3> |
---|
| 313 | <PRE> |
---|
| 314 | public <B>ZlibCompressor</B>()</PRE> |
---|
| 315 | <DL> |
---|
| 316 | <DD>Creates a new compressor with the default compression level. |
---|
| 317 | Compressed data will be generated in ZLIB format. |
---|
| 318 | <P> |
---|
| 319 | </DL> |
---|
| 320 | |
---|
| 321 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 322 | |
---|
| 323 | <A NAME="method_detail"><!-- --></A> |
---|
| 324 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 325 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 326 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 327 | <B>Method Detail</B></FONT></TH> |
---|
| 328 | </TR> |
---|
| 329 | </TABLE> |
---|
| 330 | |
---|
| 331 | <A NAME="setInput(byte[], int, int)"><!-- --></A><H3> |
---|
| 332 | setInput</H3> |
---|
| 333 | <PRE> |
---|
| 334 | public void <B>setInput</B>(byte[] b, |
---|
| 335 | int off, |
---|
| 336 | int len)</PRE> |
---|
| 337 | <DL> |
---|
| 338 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#setInput(byte[], int, int)">Compressor</A></CODE></B></DD> |
---|
| 339 | <DD>Sets input data for compression. |
---|
| 340 | This should be called whenever #needsInput() returns |
---|
| 341 | <code>true</code> indicating that more input data is required. |
---|
| 342 | <P> |
---|
| 343 | <DD><DL> |
---|
| 344 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#setInput(byte[], int, int)">setInput</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 345 | </DD> |
---|
| 346 | <DD><DL> |
---|
| 347 | <DT><B>Parameters:</B><DD><CODE>b</CODE> - Input data<DD><CODE>off</CODE> - Start offset<DD><CODE>len</CODE> - Length</DL> |
---|
| 348 | </DD> |
---|
| 349 | </DL> |
---|
| 350 | <HR> |
---|
| 351 | |
---|
| 352 | <A NAME="setDictionary(byte[], int, int)"><!-- --></A><H3> |
---|
| 353 | setDictionary</H3> |
---|
| 354 | <PRE> |
---|
| 355 | public void <B>setDictionary</B>(byte[] b, |
---|
| 356 | int off, |
---|
| 357 | int len)</PRE> |
---|
| 358 | <DL> |
---|
| 359 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#setDictionary(byte[], int, int)">Compressor</A></CODE></B></DD> |
---|
| 360 | <DD>Sets preset dictionary for compression. A preset dictionary |
---|
| 361 | is used when the history buffer can be predetermined. |
---|
| 362 | <P> |
---|
| 363 | <DD><DL> |
---|
| 364 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#setDictionary(byte[], int, int)">setDictionary</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 365 | </DD> |
---|
| 366 | <DD><DL> |
---|
| 367 | <DT><B>Parameters:</B><DD><CODE>b</CODE> - Dictionary data bytes<DD><CODE>off</CODE> - Start offset<DD><CODE>len</CODE> - Length</DL> |
---|
| 368 | </DD> |
---|
| 369 | </DL> |
---|
| 370 | <HR> |
---|
| 371 | |
---|
| 372 | <A NAME="needsInput()"><!-- --></A><H3> |
---|
| 373 | needsInput</H3> |
---|
| 374 | <PRE> |
---|
| 375 | public boolean <B>needsInput</B>()</PRE> |
---|
| 376 | <DL> |
---|
| 377 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#needsInput()">Compressor</A></CODE></B></DD> |
---|
| 378 | <DD>Returns true if the input data buffer is empty and |
---|
| 379 | #setInput() should be called to provide more input. |
---|
| 380 | <P> |
---|
| 381 | <DD><DL> |
---|
| 382 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#needsInput()">needsInput</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 383 | </DD> |
---|
| 384 | <DD><DL> |
---|
| 385 | |
---|
| 386 | <DT><B>Returns:</B><DD><code>true</code> if the input data buffer is empty and |
---|
| 387 | #setInput() should be called in order to provide more input.</DL> |
---|
| 388 | </DD> |
---|
| 389 | </DL> |
---|
| 390 | <HR> |
---|
| 391 | |
---|
| 392 | <A NAME="finish()"><!-- --></A><H3> |
---|
| 393 | finish</H3> |
---|
| 394 | <PRE> |
---|
| 395 | public void <B>finish</B>()</PRE> |
---|
| 396 | <DL> |
---|
| 397 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#finish()">Compressor</A></CODE></B></DD> |
---|
| 398 | <DD>When called, indicates that compression should end |
---|
| 399 | with the current contents of the input buffer. |
---|
| 400 | <P> |
---|
| 401 | <DD><DL> |
---|
| 402 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#finish()">finish</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 403 | </DD> |
---|
| 404 | <DD><DL> |
---|
| 405 | </DL> |
---|
| 406 | </DD> |
---|
| 407 | </DL> |
---|
| 408 | <HR> |
---|
| 409 | |
---|
| 410 | <A NAME="finished()"><!-- --></A><H3> |
---|
| 411 | finished</H3> |
---|
| 412 | <PRE> |
---|
| 413 | public boolean <B>finished</B>()</PRE> |
---|
| 414 | <DL> |
---|
| 415 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#finished()">Compressor</A></CODE></B></DD> |
---|
| 416 | <DD>Returns true if the end of the compressed |
---|
| 417 | data output stream has been reached. |
---|
| 418 | <P> |
---|
| 419 | <DD><DL> |
---|
| 420 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#finished()">finished</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 421 | </DD> |
---|
| 422 | <DD><DL> |
---|
| 423 | |
---|
| 424 | <DT><B>Returns:</B><DD><code>true</code> if the end of the compressed |
---|
| 425 | data output stream has been reached.</DL> |
---|
| 426 | </DD> |
---|
| 427 | </DL> |
---|
| 428 | <HR> |
---|
| 429 | |
---|
| 430 | <A NAME="compress(byte[], int, int)"><!-- --></A><H3> |
---|
| 431 | compress</H3> |
---|
| 432 | <PRE> |
---|
| 433 | public int <B>compress</B>(byte[] b, |
---|
| 434 | int off, |
---|
| 435 | int len) |
---|
| 436 | throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
| 437 | <DL> |
---|
| 438 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#compress(byte[], int, int)">Compressor</A></CODE></B></DD> |
---|
| 439 | <DD>Fills specified buffer with compressed data. Returns actual number |
---|
| 440 | of bytes of compressed data. A return value of 0 indicates that |
---|
| 441 | needsInput() should be called in order to determine if more input |
---|
| 442 | data is required. |
---|
| 443 | <P> |
---|
| 444 | <DD><DL> |
---|
| 445 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#compress(byte[], int, int)">compress</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 446 | </DD> |
---|
| 447 | <DD><DL> |
---|
| 448 | <DT><B>Parameters:</B><DD><CODE>b</CODE> - Buffer for the compressed data<DD><CODE>off</CODE> - Start offset of the data<DD><CODE>len</CODE> - Size of the buffer |
---|
| 449 | <DT><B>Returns:</B><DD>The actual number of bytes of compressed data. |
---|
| 450 | <DT><B>Throws:</B> |
---|
| 451 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
| 452 | </DD> |
---|
| 453 | </DL> |
---|
| 454 | <HR> |
---|
| 455 | |
---|
| 456 | <A NAME="getBytesWritten()"><!-- --></A><H3> |
---|
| 457 | getBytesWritten</H3> |
---|
| 458 | <PRE> |
---|
| 459 | public long <B>getBytesWritten</B>()</PRE> |
---|
| 460 | <DL> |
---|
| 461 | <DD>Returns the total number of compressed bytes output so far. |
---|
| 462 | <P> |
---|
| 463 | <DD><DL> |
---|
| 464 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#getBytesWritten()">getBytesWritten</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 465 | </DD> |
---|
| 466 | <DD><DL> |
---|
| 467 | |
---|
| 468 | <DT><B>Returns:</B><DD>the total (non-negative) number of compressed bytes output so far</DL> |
---|
| 469 | </DD> |
---|
| 470 | </DL> |
---|
| 471 | <HR> |
---|
| 472 | |
---|
| 473 | <A NAME="getBytesRead()"><!-- --></A><H3> |
---|
| 474 | getBytesRead</H3> |
---|
| 475 | <PRE> |
---|
| 476 | public long <B>getBytesRead</B>()</PRE> |
---|
| 477 | <DL> |
---|
| 478 | <DD>Returns the total number of uncompressed bytes input so far.</p> |
---|
| 479 | <P> |
---|
| 480 | <DD><DL> |
---|
| 481 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#getBytesRead()">getBytesRead</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 482 | </DD> |
---|
| 483 | <DD><DL> |
---|
| 484 | |
---|
| 485 | <DT><B>Returns:</B><DD>the total (non-negative) number of uncompressed bytes input so far</DL> |
---|
| 486 | </DD> |
---|
| 487 | </DL> |
---|
| 488 | <HR> |
---|
| 489 | |
---|
| 490 | <A NAME="reset()"><!-- --></A><H3> |
---|
| 491 | reset</H3> |
---|
| 492 | <PRE> |
---|
| 493 | public void <B>reset</B>()</PRE> |
---|
| 494 | <DL> |
---|
| 495 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#reset()">Compressor</A></CODE></B></DD> |
---|
| 496 | <DD>Resets compressor so that a new set of input data can be processed. |
---|
| 497 | <P> |
---|
| 498 | <DD><DL> |
---|
| 499 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 500 | </DD> |
---|
| 501 | <DD><DL> |
---|
| 502 | </DL> |
---|
| 503 | </DD> |
---|
| 504 | </DL> |
---|
| 505 | <HR> |
---|
| 506 | |
---|
| 507 | <A NAME="end()"><!-- --></A><H3> |
---|
| 508 | end</H3> |
---|
| 509 | <PRE> |
---|
| 510 | public void <B>end</B>()</PRE> |
---|
| 511 | <DL> |
---|
| 512 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#end()">Compressor</A></CODE></B></DD> |
---|
| 513 | <DD>Closes the compressor and discards any unprocessed input. |
---|
| 514 | <P> |
---|
| 515 | <DD><DL> |
---|
| 516 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html#end()">end</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></DL> |
---|
| 517 | </DD> |
---|
| 518 | <DD><DL> |
---|
| 519 | </DL> |
---|
| 520 | </DD> |
---|
| 521 | </DL> |
---|
| 522 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 523 | <HR> |
---|
| 524 | |
---|
| 525 | |
---|
| 526 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 527 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 528 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 529 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 530 | <TR> |
---|
| 531 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 532 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 533 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 534 | <TR ALIGN="center" VALIGN="top"> |
---|
| 535 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 536 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 537 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 538 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ZlibCompressor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 539 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 540 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 541 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 542 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 543 | </TR> |
---|
| 544 | </TABLE> |
---|
| 545 | </TD> |
---|
| 546 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 547 | </EM> |
---|
| 548 | </TD> |
---|
| 549 | </TR> |
---|
| 550 | |
---|
| 551 | <TR> |
---|
| 552 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 553 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/BuiltInZlibInflater.html" title="class in org.apache.hadoop.io.compress.zlib"><B>PREV CLASS</B></A> |
---|
| 554 | <A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 555 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 556 | <A HREF="../../../../../../index.html?org/apache/hadoop/io/compress/zlib/ZlibCompressor.html" target="_top"><B>FRAMES</B></A> |
---|
| 557 | <A HREF="ZlibCompressor.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 558 | <SCRIPT type="text/javascript"> |
---|
| 559 | <!-- |
---|
| 560 | if(window==top) { |
---|
| 561 | document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 562 | } |
---|
| 563 | //--> |
---|
| 564 | </SCRIPT> |
---|
| 565 | <NOSCRIPT> |
---|
| 566 | <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 567 | </NOSCRIPT> |
---|
| 568 | |
---|
| 569 | |
---|
| 570 | </FONT></TD> |
---|
| 571 | </TR> |
---|
| 572 | <TR> |
---|
| 573 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 574 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 575 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 576 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 577 | </TR> |
---|
| 578 | </TABLE> |
---|
| 579 | <A NAME="skip-navbar_bottom"></A> |
---|
| 580 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 581 | |
---|
| 582 | <HR> |
---|
| 583 | Copyright © 2009 The Apache Software Foundation |
---|
| 584 | </BODY> |
---|
| 585 | </HTML> |
---|