source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/file/tfile/RawComparable.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: 10.6 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>
7RawComparable (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="RawComparable (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/RawComparable.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/file/tfile/MetaBlockDoesNotExist.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.html" title="class in org.apache.hadoop.io.file.tfile"><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/file/tfile/RawComparable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RawComparable.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.file.tfile</FONT>
92<BR>
93Interface RawComparable</H2>
94<DL>
95<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/ByteArray.html" title="class in org.apache.hadoop.io.file.tfile">ByteArray</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public interface <B>RawComparable</B></DL>
100</PRE>
101
102<P>
103Interface for objects that can be compared through <A HREF="../../../../../../org/apache/hadoop/io/RawComparator.html" title="interface in org.apache.hadoop.io"><CODE>RawComparator</CODE></A>.
104 This is useful in places where we need a single object reference to specify a
105 range of bytes in a byte array, such as <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><CODE>Comparable</CODE></A> or
106 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collections.html?is-external=true#binarySearch(java.util.List, T, java.util.Comparator)" title="class or interface in java.util"><CODE>Collections.binarySearch(java.util.List, Object, Comparator)</CODE></A>
107 
108 The actual comparison among RawComparable's requires an external
109 RawComparator and it is applications' responsibility to ensure two
110 RawComparable are supposed to be semantically comparable with the same
111 RawComparator.
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;byte[]</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html#buffer()">buffer</A></B>()</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the underlying byte array.</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;int</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html#offset()">offset</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the offset of the first byte in the byte array.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;int</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html#size()">size</A></B>()</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the size of the byte range in the byte array.</TD>
150</TR>
151</TABLE>
152&nbsp;
153<P>
154
155<!-- ============ METHOD DETAIL ========== -->
156
157<A NAME="method_detail"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
161<B>Method Detail</B></FONT></TH>
162</TR>
163</TABLE>
164
165<A NAME="buffer()"><!-- --></A><H3>
166buffer</H3>
167<PRE>
168byte[] <B>buffer</B>()</PRE>
169<DL>
170<DD>Get the underlying byte array.
171<P>
172<DD><DL>
173
174<DT><B>Returns:</B><DD>The underlying byte array.</DL>
175</DD>
176</DL>
177<HR>
178
179<A NAME="offset()"><!-- --></A><H3>
180offset</H3>
181<PRE>
182int <B>offset</B>()</PRE>
183<DL>
184<DD>Get the offset of the first byte in the byte array.
185<P>
186<DD><DL>
187
188<DT><B>Returns:</B><DD>The offset of the first byte in the byte array.</DL>
189</DD>
190</DL>
191<HR>
192
193<A NAME="size()"><!-- --></A><H3>
194size</H3>
195<PRE>
196int <B>size</B>()</PRE>
197<DL>
198<DD>Get the size of the byte range in the byte array.
199<P>
200<DD><DL>
201
202<DT><B>Returns:</B><DD>The size of the byte range in the byte array.</DL>
203</DD>
204</DL>
205<!-- ========= END OF CLASS DATA ========= -->
206<HR>
207
208
209<!-- ======= START OF BOTTOM NAVBAR ====== -->
210<A NAME="navbar_bottom"><!-- --></A>
211<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
212<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
213<TR>
214<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
215<A NAME="navbar_bottom_firstrow"><!-- --></A>
216<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
217  <TR ALIGN="center" VALIGN="top">
218  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
219  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
220  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
221  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RawComparable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
222  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
223  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
224  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
225  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
226  </TR>
227</TABLE>
228</TD>
229<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
230</EM>
231</TD>
232</TR>
233
234<TR>
235<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
236&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/MetaBlockDoesNotExist.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A>&nbsp;
237&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.html" title="class in org.apache.hadoop.io.file.tfile"><B>NEXT CLASS</B></A></FONT></TD>
238<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
239  <A HREF="../../../../../../index.html?org/apache/hadoop/io/file/tfile/RawComparable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
240&nbsp;<A HREF="RawComparable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
241&nbsp;<SCRIPT type="text/javascript">
242  <!--
243  if(window==top) {
244    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
245  }
246  //-->
247</SCRIPT>
248<NOSCRIPT>
249  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
250</NOSCRIPT>
251
252
253</FONT></TD>
254</TR>
255<TR>
256<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
257  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
258<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
259DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
260</TR>
261</TABLE>
262<A NAME="skip-navbar_bottom"></A>
263<!-- ======== END OF BOTTOM NAVBAR ======= -->
264
265<HR>
266Copyright &copy; 2009 The Apache Software Foundation
267</BODY>
268</HTML>
Note: See TracBrowser for help on using the repository browser.