[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 | CompressionCodec (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="CompressionCodec (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/CompressionCodec.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/CodecPool.html" title="class in org.apache.hadoop.io.compress"><B>PREV CLASS</B></A> |
---|
| 59 | <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodecFactory.html" title="class in org.apache.hadoop.io.compress"><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/CompressionCodec.html" target="_top"><B>FRAMES</B></A> |
---|
| 62 | <A HREF="CompressionCodec.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 81 | DETAIL: FIELD | CONSTR | <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</FONT> |
---|
| 92 | <BR> |
---|
| 93 | Interface CompressionCodec</H2> |
---|
| 94 | <DL> |
---|
| 95 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/hadoop/io/compress/BZip2Codec.html" title="class in org.apache.hadoop.io.compress">BZip2Codec</A>, <A HREF="../../../../../org/apache/hadoop/io/compress/DefaultCodec.html" title="class in org.apache.hadoop.io.compress">DefaultCodec</A>, <A HREF="../../../../../org/apache/hadoop/io/compress/GzipCodec.html" title="class in org.apache.hadoop.io.compress">GzipCodec</A></DD> |
---|
| 96 | </DL> |
---|
| 97 | <HR> |
---|
| 98 | <DL> |
---|
| 99 | <DT><PRE>public interface <B>CompressionCodec</B></DL> |
---|
| 100 | </PRE> |
---|
| 101 | |
---|
| 102 | <P> |
---|
| 103 | This class encapsulates a streaming compression/decompression pair. |
---|
| 104 | <P> |
---|
| 105 | |
---|
| 106 | <P> |
---|
| 107 | <HR> |
---|
| 108 | |
---|
| 109 | <P> |
---|
| 110 | |
---|
| 111 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 112 | |
---|
| 113 | <A NAME="method_summary"><!-- --></A> |
---|
| 114 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 115 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 116 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 117 | <B>Method Summary</B></FONT></TH> |
---|
| 118 | </TR> |
---|
| 119 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 120 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 121 | <CODE> <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A></CODE></FONT></TD> |
---|
| 122 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#createCompressor()">createCompressor</A></B>()</CODE> |
---|
| 123 | |
---|
| 124 | <BR> |
---|
| 125 | Create a new <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A> for use by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>.</TD> |
---|
| 126 | </TR> |
---|
| 127 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 128 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 129 | <CODE> <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></FONT></TD> |
---|
| 130 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#createDecompressor()">createDecompressor</A></B>()</CODE> |
---|
| 131 | |
---|
| 132 | <BR> |
---|
| 133 | Create a new <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</CODE></A> for use by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>.</TD> |
---|
| 134 | </TR> |
---|
| 135 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 136 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 137 | <CODE> <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionInputStream.html" title="class in org.apache.hadoop.io.compress">CompressionInputStream</A></CODE></FONT></TD> |
---|
| 138 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#createInputStream(java.io.InputStream)">createInputStream</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> in)</CODE> |
---|
| 139 | |
---|
| 140 | <BR> |
---|
| 141 | Create a stream decompressor that will read from the given input stream.</TD> |
---|
| 142 | </TR> |
---|
| 143 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 144 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 145 | <CODE> <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionInputStream.html" title="class in org.apache.hadoop.io.compress">CompressionInputStream</A></CODE></FONT></TD> |
---|
| 146 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#createInputStream(java.io.InputStream, org.apache.hadoop.io.compress.Decompressor)">createInputStream</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> in, |
---|
| 147 | <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A> decompressor)</CODE> |
---|
| 148 | |
---|
| 149 | <BR> |
---|
| 150 | Create a <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionInputStream.html" title="class in org.apache.hadoop.io.compress"><CODE>CompressionInputStream</CODE></A> that will read from the given |
---|
| 151 | <A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><CODE>InputStream</CODE></A> with the given <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</CODE></A>.</TD> |
---|
| 152 | </TR> |
---|
| 153 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 154 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 155 | <CODE> <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress">CompressionOutputStream</A></CODE></FONT></TD> |
---|
| 156 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#createOutputStream(java.io.OutputStream)">createOutputStream</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out)</CODE> |
---|
| 157 | |
---|
| 158 | <BR> |
---|
| 159 | Create a <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress"><CODE>CompressionOutputStream</CODE></A> that will write to the given |
---|
| 160 | <A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><CODE>OutputStream</CODE></A>.</TD> |
---|
| 161 | </TR> |
---|
| 162 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 163 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 164 | <CODE> <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress">CompressionOutputStream</A></CODE></FONT></TD> |
---|
| 165 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#createOutputStream(java.io.OutputStream, org.apache.hadoop.io.compress.Compressor)">createOutputStream</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out, |
---|
| 166 | <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A> compressor)</CODE> |
---|
| 167 | |
---|
| 168 | <BR> |
---|
| 169 | Create a <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress"><CODE>CompressionOutputStream</CODE></A> that will write to the given |
---|
| 170 | <A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><CODE>OutputStream</CODE></A> with the given <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A>.</TD> |
---|
| 171 | </TR> |
---|
| 172 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 173 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 174 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><? extends <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A>></CODE></FONT></TD> |
---|
| 175 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#getCompressorType()">getCompressorType</A></B>()</CODE> |
---|
| 176 | |
---|
| 177 | <BR> |
---|
| 178 | Get the type of <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A> needed by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>.</TD> |
---|
| 179 | </TR> |
---|
| 180 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 181 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 182 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><? extends <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A>></CODE></FONT></TD> |
---|
| 183 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#getDecompressorType()">getDecompressorType</A></B>()</CODE> |
---|
| 184 | |
---|
| 185 | <BR> |
---|
| 186 | Get the type of <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</CODE></A> needed by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>.</TD> |
---|
| 187 | </TR> |
---|
| 188 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 189 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 190 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
| 191 | <TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html#getDefaultExtension()">getDefaultExtension</A></B>()</CODE> |
---|
| 192 | |
---|
| 193 | <BR> |
---|
| 194 | Get the default filename extension for this kind of compression.</TD> |
---|
| 195 | </TR> |
---|
| 196 | </TABLE> |
---|
| 197 | |
---|
| 198 | <P> |
---|
| 199 | |
---|
| 200 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 201 | |
---|
| 202 | <A NAME="method_detail"><!-- --></A> |
---|
| 203 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 204 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 205 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 206 | <B>Method Detail</B></FONT></TH> |
---|
| 207 | </TR> |
---|
| 208 | </TABLE> |
---|
| 209 | |
---|
| 210 | <A NAME="createOutputStream(java.io.OutputStream)"><!-- --></A><H3> |
---|
| 211 | createOutputStream</H3> |
---|
| 212 | <PRE> |
---|
| 213 | <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress">CompressionOutputStream</A> <B>createOutputStream</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out) |
---|
| 214 | 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> |
---|
| 215 | <DL> |
---|
| 216 | <DD>Create a <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress"><CODE>CompressionOutputStream</CODE></A> that will write to the given |
---|
| 217 | <A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><CODE>OutputStream</CODE></A>. |
---|
| 218 | <P> |
---|
| 219 | <DD><DL> |
---|
| 220 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - the location for the final output stream |
---|
| 221 | <DT><B>Returns:</B><DD>a stream the user can write uncompressed data to have it compressed |
---|
| 222 | <DT><B>Throws:</B> |
---|
| 223 | <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> |
---|
| 224 | </DD> |
---|
| 225 | </DL> |
---|
| 226 | <HR> |
---|
| 227 | |
---|
| 228 | <A NAME="createOutputStream(java.io.OutputStream, org.apache.hadoop.io.compress.Compressor)"><!-- --></A><H3> |
---|
| 229 | createOutputStream</H3> |
---|
| 230 | <PRE> |
---|
| 231 | <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress">CompressionOutputStream</A> <B>createOutputStream</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out, |
---|
| 232 | <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A> compressor) |
---|
| 233 | 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> |
---|
| 234 | <DL> |
---|
| 235 | <DD>Create a <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionOutputStream.html" title="class in org.apache.hadoop.io.compress"><CODE>CompressionOutputStream</CODE></A> that will write to the given |
---|
| 236 | <A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><CODE>OutputStream</CODE></A> with the given <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A>. |
---|
| 237 | <P> |
---|
| 238 | <DD><DL> |
---|
| 239 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - the location for the final output stream<DD><CODE>compressor</CODE> - compressor to use |
---|
| 240 | <DT><B>Returns:</B><DD>a stream the user can write uncompressed data to have it compressed |
---|
| 241 | <DT><B>Throws:</B> |
---|
| 242 | <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> |
---|
| 243 | </DD> |
---|
| 244 | </DL> |
---|
| 245 | <HR> |
---|
| 246 | |
---|
| 247 | <A NAME="getCompressorType()"><!-- --></A><H3> |
---|
| 248 | getCompressorType</H3> |
---|
| 249 | <PRE> |
---|
| 250 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><? extends <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A>> <B>getCompressorType</B>()</PRE> |
---|
| 251 | <DL> |
---|
| 252 | <DD>Get the type of <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A> needed by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>. |
---|
| 253 | <P> |
---|
| 254 | <DD><DL> |
---|
| 255 | |
---|
| 256 | <DT><B>Returns:</B><DD>the type of compressor needed by this codec.</DL> |
---|
| 257 | </DD> |
---|
| 258 | </DL> |
---|
| 259 | <HR> |
---|
| 260 | |
---|
| 261 | <A NAME="createCompressor()"><!-- --></A><H3> |
---|
| 262 | createCompressor</H3> |
---|
| 263 | <PRE> |
---|
| 264 | <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress">Compressor</A> <B>createCompressor</B>()</PRE> |
---|
| 265 | <DL> |
---|
| 266 | <DD>Create a new <A HREF="../../../../../org/apache/hadoop/io/compress/Compressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Compressor</CODE></A> for use by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>. |
---|
| 267 | <P> |
---|
| 268 | <DD><DL> |
---|
| 269 | |
---|
| 270 | <DT><B>Returns:</B><DD>a new compressor for use by this codec</DL> |
---|
| 271 | </DD> |
---|
| 272 | </DL> |
---|
| 273 | <HR> |
---|
| 274 | |
---|
| 275 | <A NAME="createInputStream(java.io.InputStream)"><!-- --></A><H3> |
---|
| 276 | createInputStream</H3> |
---|
| 277 | <PRE> |
---|
| 278 | <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionInputStream.html" title="class in org.apache.hadoop.io.compress">CompressionInputStream</A> <B>createInputStream</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> in) |
---|
| 279 | 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> |
---|
| 280 | <DL> |
---|
| 281 | <DD>Create a stream decompressor that will read from the given input stream. |
---|
| 282 | <P> |
---|
| 283 | <DD><DL> |
---|
| 284 | <DT><B>Parameters:</B><DD><CODE>in</CODE> - the stream to read compressed bytes from |
---|
| 285 | <DT><B>Returns:</B><DD>a stream to read uncompressed bytes from |
---|
| 286 | <DT><B>Throws:</B> |
---|
| 287 | <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> |
---|
| 288 | </DD> |
---|
| 289 | </DL> |
---|
| 290 | <HR> |
---|
| 291 | |
---|
| 292 | <A NAME="createInputStream(java.io.InputStream, org.apache.hadoop.io.compress.Decompressor)"><!-- --></A><H3> |
---|
| 293 | createInputStream</H3> |
---|
| 294 | <PRE> |
---|
| 295 | <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionInputStream.html" title="class in org.apache.hadoop.io.compress">CompressionInputStream</A> <B>createInputStream</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> in, |
---|
| 296 | <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A> decompressor) |
---|
| 297 | 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> |
---|
| 298 | <DL> |
---|
| 299 | <DD>Create a <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionInputStream.html" title="class in org.apache.hadoop.io.compress"><CODE>CompressionInputStream</CODE></A> that will read from the given |
---|
| 300 | <A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><CODE>InputStream</CODE></A> with the given <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</CODE></A>. |
---|
| 301 | <P> |
---|
| 302 | <DD><DL> |
---|
| 303 | <DT><B>Parameters:</B><DD><CODE>in</CODE> - the stream to read compressed bytes from<DD><CODE>decompressor</CODE> - decompressor to use |
---|
| 304 | <DT><B>Returns:</B><DD>a stream to read uncompressed bytes from |
---|
| 305 | <DT><B>Throws:</B> |
---|
| 306 | <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> |
---|
| 307 | </DD> |
---|
| 308 | </DL> |
---|
| 309 | <HR> |
---|
| 310 | |
---|
| 311 | <A NAME="getDecompressorType()"><!-- --></A><H3> |
---|
| 312 | getDecompressorType</H3> |
---|
| 313 | <PRE> |
---|
| 314 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><? extends <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A>> <B>getDecompressorType</B>()</PRE> |
---|
| 315 | <DL> |
---|
| 316 | <DD>Get the type of <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</CODE></A> needed by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>. |
---|
| 317 | <P> |
---|
| 318 | <DD><DL> |
---|
| 319 | |
---|
| 320 | <DT><B>Returns:</B><DD>the type of decompressor needed by this codec.</DL> |
---|
| 321 | </DD> |
---|
| 322 | </DL> |
---|
| 323 | <HR> |
---|
| 324 | |
---|
| 325 | <A NAME="createDecompressor()"><!-- --></A><H3> |
---|
| 326 | createDecompressor</H3> |
---|
| 327 | <PRE> |
---|
| 328 | <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A> <B>createDecompressor</B>()</PRE> |
---|
| 329 | <DL> |
---|
| 330 | <DD>Create a new <A HREF="../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</CODE></A> for use by this <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress"><CODE>CompressionCodec</CODE></A>. |
---|
| 331 | <P> |
---|
| 332 | <DD><DL> |
---|
| 333 | |
---|
| 334 | <DT><B>Returns:</B><DD>a new decompressor for use by this codec</DL> |
---|
| 335 | </DD> |
---|
| 336 | </DL> |
---|
| 337 | <HR> |
---|
| 338 | |
---|
| 339 | <A NAME="getDefaultExtension()"><!-- --></A><H3> |
---|
| 340 | getDefaultExtension</H3> |
---|
| 341 | <PRE> |
---|
| 342 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDefaultExtension</B>()</PRE> |
---|
| 343 | <DL> |
---|
| 344 | <DD>Get the default filename extension for this kind of compression. |
---|
| 345 | <P> |
---|
| 346 | <DD><DL> |
---|
| 347 | |
---|
| 348 | <DT><B>Returns:</B><DD>the extension including the '.'</DL> |
---|
| 349 | </DD> |
---|
| 350 | </DL> |
---|
| 351 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 352 | <HR> |
---|
| 353 | |
---|
| 354 | |
---|
| 355 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 356 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 357 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 358 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 359 | <TR> |
---|
| 360 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 361 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 362 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 363 | <TR ALIGN="center" VALIGN="top"> |
---|
| 364 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 365 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 366 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 367 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CompressionCodec.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 368 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 369 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 370 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 371 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 372 | </TR> |
---|
| 373 | </TABLE> |
---|
| 374 | </TD> |
---|
| 375 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 376 | </EM> |
---|
| 377 | </TD> |
---|
| 378 | </TR> |
---|
| 379 | |
---|
| 380 | <TR> |
---|
| 381 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 382 | <A HREF="../../../../../org/apache/hadoop/io/compress/CodecPool.html" title="class in org.apache.hadoop.io.compress"><B>PREV CLASS</B></A> |
---|
| 383 | <A HREF="../../../../../org/apache/hadoop/io/compress/CompressionCodecFactory.html" title="class in org.apache.hadoop.io.compress"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 384 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 385 | <A HREF="../../../../../index.html?org/apache/hadoop/io/compress/CompressionCodec.html" target="_top"><B>FRAMES</B></A> |
---|
| 386 | <A HREF="CompressionCodec.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 387 | <SCRIPT type="text/javascript"> |
---|
| 388 | <!-- |
---|
| 389 | if(window==top) { |
---|
| 390 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 391 | } |
---|
| 392 | //--> |
---|
| 393 | </SCRIPT> |
---|
| 394 | <NOSCRIPT> |
---|
| 395 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 396 | </NOSCRIPT> |
---|
| 397 | |
---|
| 398 | |
---|
| 399 | </FONT></TD> |
---|
| 400 | </TR> |
---|
| 401 | <TR> |
---|
| 402 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 403 | SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 404 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 405 | DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 406 | </TR> |
---|
| 407 | </TABLE> |
---|
| 408 | <A NAME="skip-navbar_bottom"></A> |
---|
| 409 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 410 | |
---|
| 411 | <HR> |
---|
| 412 | Copyright © 2009 The Apache Software Foundation |
---|
| 413 | </BODY> |
---|
| 414 | </HTML> |
---|