source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/serializer/Deserializer.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: 11.7 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>
7Deserializer (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="Deserializer (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/Deserializer.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;PREV CLASS&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/io/serializer/DeserializerComparator.html" title="class in org.apache.hadoop.io.serializer"><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/serializer/Deserializer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="Deserializer.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;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.serializer</FONT>
92<BR>
93Interface Deserializer&lt;T&gt;</H2>
94<DL>
95<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - </DL>
96<HR>
97<DL>
98<DT><PRE>public interface <B>Deserializer&lt;T&gt;</B></DL>
99</PRE>
100
101<P>
102<p>
103 Provides a facility for deserializing objects of type <T> from an
104 <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>.
105 </p>
106 
107 <p>
108 Deserializers are stateful, but must not buffer the input since
109 other producers may read from the input between calls to
110 <A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html#deserialize(T)"><CODE>deserialize(Object)</CODE></A>.
111 </p>
112<P>
113
114<P>
115<HR>
116
117<P>
118
119<!-- ========== METHOD SUMMARY =========== -->
120
121<A NAME="method_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Method Summary</B></FONT></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>&nbsp;void</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html#close()">close</A></B>()</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the underlying input stream and clear up any resources.</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;<A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html" title="type parameter in Deserializer">T</A></CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html#deserialize(T)">deserialize</A></B>(<A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html" title="type parameter in Deserializer">T</A>&nbsp;t)</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142 Deserialize the next object from the underlying input stream.</TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>&nbsp;void</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html#open(java.io.InputStream)">open</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>&nbsp;in)</CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare the deserializer for reading.</TD>
151</TR>
152</TABLE>
153&nbsp;
154<P>
155
156<!-- ============ METHOD DETAIL ========== -->
157
158<A NAME="method_detail"><!-- --></A>
159<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
162<B>Method Detail</B></FONT></TH>
163</TR>
164</TABLE>
165
166<A NAME="open(java.io.InputStream)"><!-- --></A><H3>
167open</H3>
168<PRE>
169void <B>open</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>&nbsp;in)
170          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>
171<DL>
172<DD><p>Prepare the deserializer for reading.</p>
173<P>
174<DD><DL>
175
176<DT><B>Throws:</B>
177<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>
178</DD>
179</DL>
180<HR>
181
182<A NAME="deserialize(java.lang.Object)"><!-- --></A><A NAME="deserialize(T)"><!-- --></A><H3>
183deserialize</H3>
184<PRE>
185<A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html" title="type parameter in Deserializer">T</A> <B>deserialize</B>(<A HREF="../../../../../org/apache/hadoop/io/serializer/Deserializer.html" title="type parameter in Deserializer">T</A>&nbsp;t)
186              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>
187<DL>
188<DD><p>
189 Deserialize the next object from the underlying input stream.
190 If the object <code>t</code> is non-null then this deserializer
191 <i>may</i> set its internal state to the next object read from the input
192 stream. Otherwise, if the object <code>t</code> is null a new
193 deserialized object will be created.
194 </p>
195<P>
196<DD><DL>
197
198<DT><B>Returns:</B><DD>the deserialized object
199<DT><B>Throws:</B>
200<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>
201</DD>
202</DL>
203<HR>
204
205<A NAME="close()"><!-- --></A><H3>
206close</H3>
207<PRE>
208void <B>close</B>()
209           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>
210<DL>
211<DD><p>Close the underlying input stream and clear up any resources.</p>
212<P>
213<DD><DL>
214
215<DT><B>Throws:</B>
216<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>
217</DD>
218</DL>
219<!-- ========= END OF CLASS DATA ========= -->
220<HR>
221
222
223<!-- ======= START OF BOTTOM NAVBAR ====== -->
224<A NAME="navbar_bottom"><!-- --></A>
225<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
226<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
227<TR>
228<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
229<A NAME="navbar_bottom_firstrow"><!-- --></A>
230<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
231  <TR ALIGN="center" VALIGN="top">
232  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
233  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
234  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
235  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Deserializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
236  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
237  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
238  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
239  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
240  </TR>
241</TABLE>
242</TD>
243<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
244</EM>
245</TD>
246</TR>
247
248<TR>
249<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
250&nbsp;PREV CLASS&nbsp;
251&nbsp;<A HREF="../../../../../org/apache/hadoop/io/serializer/DeserializerComparator.html" title="class in org.apache.hadoop.io.serializer"><B>NEXT CLASS</B></A></FONT></TD>
252<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
253  <A HREF="../../../../../index.html?org/apache/hadoop/io/serializer/Deserializer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
254&nbsp;<A HREF="Deserializer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
255&nbsp;<SCRIPT type="text/javascript">
256  <!--
257  if(window==top) {
258    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
259  }
260  //-->
261</SCRIPT>
262<NOSCRIPT>
263  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
264</NOSCRIPT>
265
266
267</FONT></TD>
268</TR>
269<TR>
270<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
271  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
272<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
273DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
274</TR>
275</TABLE>
276<A NAME="skip-navbar_bottom"></A>
277<!-- ======== END OF BOTTOM NAVBAR ======= -->
278
279<HR>
280Copyright &copy; 2009 The Apache Software Foundation
281</BODY>
282</HTML>
Note: See TracBrowser for help on using the repository browser.