Try adding current javadoc to SVN
[zxing.git] / docs / javadoc / com / google / zxing / common / DecoderResult.html
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_13) on Fri Jun 26 13:12:29 EDT 2009 -->
6 <TITLE>
7 DecoderResult
8 </TITLE>
9
10 <META NAME="date" CONTENT="2009-06-26">
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="DecoderResult";
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="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47   </TR>
48 </TABLE>
49 </TD>
50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51 </EM>
52 </TD>
53 </TR>
54
55 <TR>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 &nbsp;<A HREF="../../../../com/google/zxing/common/CroppedMonochromeBitmapSource.html" title="class in com.google.zxing.common"><B>PREV CLASS</B></A>&nbsp;
58 &nbsp;<A HREF="../../../../com/google/zxing/common/DefaultGridSampler.html" title="class in com.google.zxing.common"><B>NEXT CLASS</B></A></FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60   <A HREF="../../../../index.html?com/google/zxing/common/DecoderResult.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61 &nbsp;<A HREF="DecoderResult.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62 &nbsp;<SCRIPT type="text/javascript">
63   <!--
64   if(window==top) {
65     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66   }
67   //-->
68 </SCRIPT>
69 <NOSCRIPT>
70   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
71 </NOSCRIPT>
72
73
74 </FONT></TD>
75 </TR>
76 <TR>
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81 </TR>
82 </TABLE>
83 <A NAME="skip-navbar_top"></A>
84 <!-- ========= END OF TOP NAVBAR ========= -->
85
86 <HR>
87 <!-- ======== START OF CLASS DATA ======== -->
88 <H2>
89 <FONT SIZE="-1">
90 com.google.zxing.common</FONT>
91 <BR>
92 Class DecoderResult</H2>
93 <PRE>
94 java.lang.Object
95   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.common.DecoderResult</B>
96 </PRE>
97 <HR>
98 <DL>
99 <DT><PRE>public final class <B>DecoderResult</B><DT>extends java.lang.Object</DL>
100 </PRE>
101
102 <P>
103 <p>Encapsulates the result of decoding a matrix of bits. This typically
104  applies to 2D barcode formats. For now it contains the raw bytes obtained,
105  as well as a String interpretation of those bytes, if applicable.</p>
106 <P>
107
108 <P>
109 <DL>
110 <DT><B>Author:</B></DT>
111   <DD>Sean Owen</DD>
112 </DL>
113 <HR>
114
115 <P>
116
117 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
118
119 <A NAME="constructor_summary"><!-- --></A>
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123 <B>Constructor Summary</B></FONT></TH>
124 </TR>
125 <TR BGCOLOR="white" CLASS="TableRowColor">
126 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/DecoderResult.html#DecoderResult(byte[], java.lang.String, java.util.Vector)">DecoderResult</A></B>(byte[]&nbsp;rawBytes,
127               java.lang.String&nbsp;text,
128               java.util.Vector&nbsp;byteSegments)</CODE>
129
130 <BR>
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
132 </TR>
133 </TABLE>
134 &nbsp;
135 <!-- ========== METHOD SUMMARY =========== -->
136
137 <A NAME="method_summary"><!-- --></A>
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141 <B>Method Summary</B></FONT></TH>
142 </TR>
143 <TR BGCOLOR="white" CLASS="TableRowColor">
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145 <CODE>&nbsp;java.util.Vector</CODE></FONT></TD>
146 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/DecoderResult.html#getByteSegments()">getByteSegments</A></B>()</CODE>
147
148 <BR>
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150 </TR>
151 <TR BGCOLOR="white" CLASS="TableRowColor">
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153 <CODE>&nbsp;byte[]</CODE></FONT></TD>
154 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/DecoderResult.html#getRawBytes()">getRawBytes</A></B>()</CODE>
155
156 <BR>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158 </TR>
159 <TR BGCOLOR="white" CLASS="TableRowColor">
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
162 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/DecoderResult.html#getText()">getText</A></B>()</CODE>
163
164 <BR>
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
166 </TR>
167 </TABLE>
168 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
172 </TR>
173 <TR BGCOLOR="white" CLASS="TableRowColor">
174 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
175 </TR>
176 </TABLE>
177 &nbsp;
178 <P>
179
180 <!-- ========= CONSTRUCTOR DETAIL ======== -->
181
182 <A NAME="constructor_detail"><!-- --></A>
183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
186 <B>Constructor Detail</B></FONT></TH>
187 </TR>
188 </TABLE>
189
190 <A NAME="DecoderResult(byte[], java.lang.String, java.util.Vector)"><!-- --></A><H3>
191 DecoderResult</H3>
192 <PRE>
193 public <B>DecoderResult</B>(byte[]&nbsp;rawBytes,
194                      java.lang.String&nbsp;text,
195                      java.util.Vector&nbsp;byteSegments)</PRE>
196 <DL>
197 </DL>
198
199 <!-- ============ METHOD DETAIL ========== -->
200
201 <A NAME="method_detail"><!-- --></A>
202 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
205 <B>Method Detail</B></FONT></TH>
206 </TR>
207 </TABLE>
208
209 <A NAME="getRawBytes()"><!-- --></A><H3>
210 getRawBytes</H3>
211 <PRE>
212 public byte[] <B>getRawBytes</B>()</PRE>
213 <DL>
214 <DD><DL>
215 </DL>
216 </DD>
217 </DL>
218 <HR>
219
220 <A NAME="getText()"><!-- --></A><H3>
221 getText</H3>
222 <PRE>
223 public java.lang.String <B>getText</B>()</PRE>
224 <DL>
225 <DD><DL>
226 </DL>
227 </DD>
228 </DL>
229 <HR>
230
231 <A NAME="getByteSegments()"><!-- --></A><H3>
232 getByteSegments</H3>
233 <PRE>
234 public java.util.Vector <B>getByteSegments</B>()</PRE>
235 <DL>
236 <DD><DL>
237 </DL>
238 </DD>
239 </DL>
240 <!-- ========= END OF CLASS DATA ========= -->
241 <HR>
242
243
244 <!-- ======= START OF BOTTOM NAVBAR ====== -->
245 <A NAME="navbar_bottom"><!-- --></A>
246 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
247 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
248 <TR>
249 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
250 <A NAME="navbar_bottom_firstrow"><!-- --></A>
251 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
252   <TR ALIGN="center" VALIGN="top">
253   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
255   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
256   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
257   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
260   </TR>
261 </TABLE>
262 </TD>
263 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
264 <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ?  "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-788492-5"); pageTracker._initData(); pageTracker._trackPageview(); </script></EM>
265 </TD>
266 </TR>
267
268 <TR>
269 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
270 &nbsp;<A HREF="../../../../com/google/zxing/common/CroppedMonochromeBitmapSource.html" title="class in com.google.zxing.common"><B>PREV CLASS</B></A>&nbsp;
271 &nbsp;<A HREF="../../../../com/google/zxing/common/DefaultGridSampler.html" title="class in com.google.zxing.common"><B>NEXT CLASS</B></A></FONT></TD>
272 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
273   <A HREF="../../../../index.html?com/google/zxing/common/DecoderResult.html" target="_top"><B>FRAMES</B></A>  &nbsp;
274 &nbsp;<A HREF="DecoderResult.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
275 &nbsp;<SCRIPT type="text/javascript">
276   <!--
277   if(window==top) {
278     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
279   }
280   //-->
281 </SCRIPT>
282 <NOSCRIPT>
283   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
284 </NOSCRIPT>
285
286
287 </FONT></TD>
288 </TR>
289 <TR>
290 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
291   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
292 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
293 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
294 </TR>
295 </TABLE>
296 <A NAME="skip-navbar_bottom"></A>
297 <!-- ======== END OF BOTTOM NAVBAR ======= -->
298
299 <HR>
300
301 </BODY>
302 </HTML>