source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 27.1 KB
Line 
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:54 UTC 2009 -->
6<TITLE>
7ZlibDecompressor (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">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="ZlibDecompressor (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>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ZlibDecompressor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionStrategy.html" title="enum in org.apache.hadoop.io.compress.zlib"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.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/ZlibDecompressor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ZlibDecompressor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<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:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
91org.apache.hadoop.io.compress.zlib</FONT>
92<BR>
93Class ZlibDecompressor</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.ZlibDecompressor</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>ZlibDecompressor</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/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></DL>
104</PRE>
105
106<P>
107A <A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress"><CODE>Decompressor</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&nbsp;class</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibDecompressor.CompressionHeader</A></B></CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The headers to detect from compressed data.</TD>
131</TR>
132</TABLE>
133&nbsp;
134<!-- ======== CONSTRUCTOR SUMMARY ======== -->
135
136<A NAME="constructor_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
140<B>Constructor Summary</B></FONT></TH>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#ZlibDecompressor()">ZlibDecompressor</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#ZlibDecompressor(org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader, int)">ZlibDecompressor</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibDecompressor.CompressionHeader</A>&nbsp;header,
150                 int&nbsp;directBufferSize)</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new decompressor.</TD>
154</TR>
155</TABLE>
156&nbsp;
157<!-- ========== METHOD SUMMARY =========== -->
158
159<A NAME="method_summary"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
163<B>Method Summary</B></FONT></TH>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>&nbsp;int</CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#decompress(byte[], int, int)">decompress</A></B>(byte[]&nbsp;b,
169           int&nbsp;off,
170           int&nbsp;len)</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills specified buffer with uncompressed data.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;void</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#end()">end</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the decompressor and discards any unprocessed input.</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>protected &nbsp;void</CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#finalize()">finalize</A></B>()</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;boolean</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#finished()">finished</A></B>()</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the end of the compressed
198 data output stream has been reached.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;long</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#getBytesRead()">getBytesRead</A></B>()</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of uncompressed bytes input so far.</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&nbsp;long</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#getBytesWritten()">getBytesWritten</A></B>()</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of compressed bytes output so far.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>&nbsp;boolean</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#needsDictionary()">needsDictionary</A></B>()</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if a preset dictionary is needed for decompression.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>&nbsp;boolean</CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#needsInput()">needsInput</A></B>()</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the input data buffer is empty and
231 #setInput() should be called to provide more input.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;void</CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#reset()">reset</A></B>()</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets decompressor so that a new set of input data can be processed.</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&nbsp;void</CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#setDictionary(byte[], int, int)">setDictionary</A></B>(byte[]&nbsp;b,
245              int&nbsp;off,
246              int&nbsp;len)</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets preset dictionary for compression.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>&nbsp;void</CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html#setInput(byte[], int, int)">setInput</A></B>(byte[]&nbsp;b,
255         int&nbsp;off,
256         int&nbsp;len)</CODE>
257
258<BR>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets input data for decompression.</TD>
260</TR>
261</TABLE>
262&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
263<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
264<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
265<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>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<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#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>
269</TR>
270</TABLE>
271&nbsp;
272<P>
273
274<!-- ========= CONSTRUCTOR DETAIL ======== -->
275
276<A NAME="constructor_detail"><!-- --></A>
277<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
278<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
279<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
280<B>Constructor Detail</B></FONT></TH>
281</TR>
282</TABLE>
283
284<A NAME="ZlibDecompressor(org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader, int)"><!-- --></A><H3>
285ZlibDecompressor</H3>
286<PRE>
287public <B>ZlibDecompressor</B>(<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib">ZlibDecompressor.CompressionHeader</A>&nbsp;header,
288                        int&nbsp;directBufferSize)</PRE>
289<DL>
290<DD>Creates a new decompressor.
291<P>
292</DL>
293<HR>
294
295<A NAME="ZlibDecompressor()"><!-- --></A><H3>
296ZlibDecompressor</H3>
297<PRE>
298public <B>ZlibDecompressor</B>()</PRE>
299<DL>
300</DL>
301
302<!-- ============ METHOD DETAIL ========== -->
303
304<A NAME="method_detail"><!-- --></A>
305<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
306<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
307<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
308<B>Method Detail</B></FONT></TH>
309</TR>
310</TABLE>
311
312<A NAME="setInput(byte[], int, int)"><!-- --></A><H3>
313setInput</H3>
314<PRE>
315public void <B>setInput</B>(byte[]&nbsp;b,
316                     int&nbsp;off,
317                     int&nbsp;len)</PRE>
318<DL>
319<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#setInput(byte[], int, int)">Decompressor</A></CODE></B></DD>
320<DD>Sets input data for decompression.
321 This should be called whenever #needsInput() returns
322 <code>true</code> indicating that more input data is required.
323<P>
324<DD><DL>
325<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#setInput(byte[], int, int)">setInput</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
326</DD>
327<DD><DL>
328<DT><B>Parameters:</B><DD><CODE>b</CODE> - Input data<DD><CODE>off</CODE> - Start offset<DD><CODE>len</CODE> - Length</DL>
329</DD>
330</DL>
331<HR>
332
333<A NAME="setDictionary(byte[], int, int)"><!-- --></A><H3>
334setDictionary</H3>
335<PRE>
336public void <B>setDictionary</B>(byte[]&nbsp;b,
337                          int&nbsp;off,
338                          int&nbsp;len)</PRE>
339<DL>
340<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#setDictionary(byte[], int, int)">Decompressor</A></CODE></B></DD>
341<DD>Sets preset dictionary for compression. A preset dictionary
342 is used when the history buffer can be predetermined.
343<P>
344<DD><DL>
345<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#setDictionary(byte[], int, int)">setDictionary</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
346</DD>
347<DD><DL>
348<DT><B>Parameters:</B><DD><CODE>b</CODE> - Dictionary data bytes<DD><CODE>off</CODE> - Start offset<DD><CODE>len</CODE> - Length</DL>
349</DD>
350</DL>
351<HR>
352
353<A NAME="needsInput()"><!-- --></A><H3>
354needsInput</H3>
355<PRE>
356public boolean <B>needsInput</B>()</PRE>
357<DL>
358<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#needsInput()">Decompressor</A></CODE></B></DD>
359<DD>Returns true if the input data buffer is empty and
360 #setInput() should be called to provide more input.
361<P>
362<DD><DL>
363<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#needsInput()">needsInput</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
364</DD>
365<DD><DL>
366
367<DT><B>Returns:</B><DD><code>true</code> if the input data buffer is empty and
368 #setInput() should be called in order to provide more input.</DL>
369</DD>
370</DL>
371<HR>
372
373<A NAME="needsDictionary()"><!-- --></A><H3>
374needsDictionary</H3>
375<PRE>
376public boolean <B>needsDictionary</B>()</PRE>
377<DL>
378<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#needsDictionary()">Decompressor</A></CODE></B></DD>
379<DD>Returns <code>true</code> if a preset dictionary is needed for decompression.
380<P>
381<DD><DL>
382<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#needsDictionary()">needsDictionary</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
383</DD>
384<DD><DL>
385
386<DT><B>Returns:</B><DD><code>true</code> if a preset dictionary is needed for decompression</DL>
387</DD>
388</DL>
389<HR>
390
391<A NAME="finished()"><!-- --></A><H3>
392finished</H3>
393<PRE>
394public boolean <B>finished</B>()</PRE>
395<DL>
396<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#finished()">Decompressor</A></CODE></B></DD>
397<DD>Returns true if the end of the compressed
398 data output stream has been reached.
399<P>
400<DD><DL>
401<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#finished()">finished</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
402</DD>
403<DD><DL>
404
405<DT><B>Returns:</B><DD><code>true</code> if the end of the compressed
406 data output stream has been reached.</DL>
407</DD>
408</DL>
409<HR>
410
411<A NAME="decompress(byte[], int, int)"><!-- --></A><H3>
412decompress</H3>
413<PRE>
414public int <B>decompress</B>(byte[]&nbsp;b,
415                      int&nbsp;off,
416                      int&nbsp;len)
417               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>
418<DL>
419<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#decompress(byte[], int, int)">Decompressor</A></CODE></B></DD>
420<DD>Fills specified buffer with uncompressed data. Returns actual number
421 of bytes of uncompressed data. A return value of 0 indicates that
422 #needsInput() should be called in order to determine if more input
423 data is required.
424<P>
425<DD><DL>
426<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#decompress(byte[], int, int)">decompress</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
427</DD>
428<DD><DL>
429<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
430<DT><B>Returns:</B><DD>The actual number of bytes of compressed data.
431<DT><B>Throws:</B>
432<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>
433</DD>
434</DL>
435<HR>
436
437<A NAME="getBytesWritten()"><!-- --></A><H3>
438getBytesWritten</H3>
439<PRE>
440public long <B>getBytesWritten</B>()</PRE>
441<DL>
442<DD>Returns the total number of compressed bytes output so far.
443<P>
444<DD><DL>
445</DL>
446</DD>
447<DD><DL>
448
449<DT><B>Returns:</B><DD>the total (non-negative) number of compressed bytes output so far</DL>
450</DD>
451</DL>
452<HR>
453
454<A NAME="getBytesRead()"><!-- --></A><H3>
455getBytesRead</H3>
456<PRE>
457public long <B>getBytesRead</B>()</PRE>
458<DL>
459<DD>Returns the total number of uncompressed bytes input so far.</p>
460<P>
461<DD><DL>
462</DL>
463</DD>
464<DD><DL>
465
466<DT><B>Returns:</B><DD>the total (non-negative) number of uncompressed bytes input so far</DL>
467</DD>
468</DL>
469<HR>
470
471<A NAME="reset()"><!-- --></A><H3>
472reset</H3>
473<PRE>
474public void <B>reset</B>()</PRE>
475<DL>
476<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#reset()">Decompressor</A></CODE></B></DD>
477<DD>Resets decompressor so that a new set of input data can be processed.
478<P>
479<DD><DL>
480<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
481</DD>
482<DD><DL>
483</DL>
484</DD>
485</DL>
486<HR>
487
488<A NAME="end()"><!-- --></A><H3>
489end</H3>
490<PRE>
491public void <B>end</B>()</PRE>
492<DL>
493<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#end()">Decompressor</A></CODE></B></DD>
494<DD>Closes the decompressor and discards any unprocessed input.
495<P>
496<DD><DL>
497<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html#end()">end</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/compress/Decompressor.html" title="interface in org.apache.hadoop.io.compress">Decompressor</A></CODE></DL>
498</DD>
499<DD><DL>
500</DL>
501</DD>
502</DL>
503<HR>
504
505<A NAME="finalize()"><!-- --></A><H3>
506finalize</H3>
507<PRE>
508protected void <B>finalize</B>()</PRE>
509<DL>
510<DD><DL>
511<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
512</DD>
513<DD><DL>
514</DL>
515</DD>
516</DL>
517<!-- ========= END OF CLASS DATA ========= -->
518<HR>
519
520
521<!-- ======= START OF BOTTOM NAVBAR ====== -->
522<A NAME="navbar_bottom"><!-- --></A>
523<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
524<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
525<TR>
526<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
527<A NAME="navbar_bottom_firstrow"><!-- --></A>
528<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
529  <TR ALIGN="center" VALIGN="top">
530  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
531  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
532  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
533  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ZlibDecompressor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
534  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
535  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
536  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
537  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
538  </TR>
539</TABLE>
540</TD>
541<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
542</EM>
543</TD>
544</TR>
545
546<TR>
547<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
548&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibCompressor.CompressionStrategy.html" title="enum in org.apache.hadoop.io.compress.zlib"><B>PREV CLASS</B></A>&nbsp;
549&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/compress/zlib/ZlibDecompressor.CompressionHeader.html" title="enum in org.apache.hadoop.io.compress.zlib"><B>NEXT CLASS</B></A></FONT></TD>
550<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
551  <A HREF="../../../../../../index.html?org/apache/hadoop/io/compress/zlib/ZlibDecompressor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
552&nbsp;<A HREF="ZlibDecompressor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
553&nbsp;<SCRIPT type="text/javascript">
554  <!--
555  if(window==top) {
556    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
557  }
558  //-->
559</SCRIPT>
560<NOSCRIPT>
561  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
562</NOSCRIPT>
563
564
565</FONT></TD>
566</TR>
567<TR>
568<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
569  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
570<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
571DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
572</TR>
573</TABLE>
574<A NAME="skip-navbar_bottom"></A>
575<!-- ======== END OF BOTTOM NAVBAR ======= -->
576
577<HR>
578Copyright &copy; 2009 The Apache Software Foundation
579</BODY>
580</HTML>
Note: See TracBrowser for help on using the repository browser.