Try adding current javadoc to SVN
[zxing.git] / docs / javadoc / com / google / zxing / DecodeHintType.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:28 EDT 2009 -->
6 <TITLE>
7 DecodeHintType
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="DecodeHintType";
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/BlackPointEstimationMethod.html" title="class in com.google.zxing"><B>PREV CLASS</B></A>&nbsp;
58 &nbsp;<A HREF="../../../com/google/zxing/EncodeHintType.html" title="class in com.google.zxing"><B>NEXT CLASS</B></A></FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60   <A HREF="../../../index.html?com/google/zxing/DecodeHintType.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61 &nbsp;<A HREF="DecodeHintType.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</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</FONT>
91 <BR>
92 Class DecodeHintType</H2>
93 <PRE>
94 java.lang.Object
95   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.DecodeHintType</B>
96 </PRE>
97 <HR>
98 <DL>
99 <DT><PRE>public final class <B>DecodeHintType</B><DT>extends java.lang.Object</DL>
100 </PRE>
101
102 <P>
103 Encapsulates a type of hint that a caller may pass to a barcode reader to help it
104  more quickly or accurately decode it. It is up to implementations to decide what,
105  if anything, to do with the information that is supplied.
106 <P>
107
108 <P>
109 <DL>
110 <DT><B>Author:</B></DT>
111   <DD>Sean Owen, dswitkin@google.com (Daniel Switkin)</DD>
112 <DT><B>See Also:</B><DD><A HREF="../../../com/google/zxing/Reader.html#decode(com.google.zxing.MonochromeBitmapSource, java.util.Hashtable)"><CODE>Reader.decode(MonochromeBitmapSource, java.util.Hashtable)</CODE></A></DL>
113 <HR>
114
115 <P>
116 <!-- =========== FIELD SUMMARY =========== -->
117
118 <A NAME="field_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>Field 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;<A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A></CODE></FONT></TD>
127 <TD><CODE><B><A HREF="../../../com/google/zxing/DecodeHintType.html#ALLOWED_LENGTHS">ALLOWED_LENGTHS</A></B></CODE>
128
129 <BR>
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allowed lengths of encoded data -- reject anything else.</TD>
131 </TR>
132 <TR BGCOLOR="white" CLASS="TableRowColor">
133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134 <CODE>static&nbsp;<A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A></CODE></FONT></TD>
135 <TD><CODE><B><A HREF="../../../com/google/zxing/DecodeHintType.html#OTHER">OTHER</A></B></CODE>
136
137 <BR>
138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unspecified, application-specific hint.</TD>
139 </TR>
140 <TR BGCOLOR="white" CLASS="TableRowColor">
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142 <CODE>static&nbsp;<A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A></CODE></FONT></TD>
143 <TD><CODE><B><A HREF="../../../com/google/zxing/DecodeHintType.html#POSSIBLE_FORMATS">POSSIBLE_FORMATS</A></B></CODE>
144
145 <BR>
146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Image is known to be of one of a few possible formats.</TD>
147 </TR>
148 <TR BGCOLOR="white" CLASS="TableRowColor">
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150 <CODE>static&nbsp;<A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A></CODE></FONT></TD>
151 <TD><CODE><B><A HREF="../../../com/google/zxing/DecodeHintType.html#PURE_BARCODE">PURE_BARCODE</A></B></CODE>
152
153 <BR>
154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Image is a pure monochrome image of a barcode.</TD>
155 </TR>
156 <TR BGCOLOR="white" CLASS="TableRowColor">
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158 <CODE>static&nbsp;<A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A></CODE></FONT></TD>
159 <TD><CODE><B><A HREF="../../../com/google/zxing/DecodeHintType.html#TRY_HARDER">TRY_HARDER</A></B></CODE>
160
161 <BR>
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Spend more time to try to find a barcode; optimize for accuracy, not speed.</TD>
163 </TR>
164 </TABLE>
165 &nbsp;
166 <!-- ========== METHOD SUMMARY =========== -->
167
168 <A NAME="method_summary"><!-- --></A>
169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
172 <B>Method Summary</B></FONT></TH>
173 </TR>
174 </TABLE>
175 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
179 </TR>
180 <TR BGCOLOR="white" CLASS="TableRowColor">
181 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
182 </TR>
183 </TABLE>
184 &nbsp;
185 <P>
186
187 <!-- ============ FIELD DETAIL =========== -->
188
189 <A NAME="field_detail"><!-- --></A>
190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
192 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
193 <B>Field Detail</B></FONT></TH>
194 </TR>
195 </TABLE>
196
197 <A NAME="OTHER"><!-- --></A><H3>
198 OTHER</H3>
199 <PRE>
200 public static final <A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A> <B>OTHER</B></PRE>
201 <DL>
202 <DD>Unspecified, application-specific hint. Maps to an unspecified <CODE>Object</CODE>.
203 <P>
204 <DL>
205 </DL>
206 </DL>
207 <HR>
208
209 <A NAME="PURE_BARCODE"><!-- --></A><H3>
210 PURE_BARCODE</H3>
211 <PRE>
212 public static final <A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A> <B>PURE_BARCODE</B></PRE>
213 <DL>
214 <DD>Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
215  use <CODE>Boolean.TRUE</CODE>.
216 <P>
217 <DL>
218 </DL>
219 </DL>
220 <HR>
221
222 <A NAME="POSSIBLE_FORMATS"><!-- --></A><H3>
223 POSSIBLE_FORMATS</H3>
224 <PRE>
225 public static final <A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A> <B>POSSIBLE_FORMATS</B></PRE>
226 <DL>
227 <DD>Image is known to be of one of a few possible formats.
228  Maps to a <CODE>Vector</CODE> of <A HREF="../../../com/google/zxing/BarcodeFormat.html" title="class in com.google.zxing"><CODE>BarcodeFormat</CODE></A>s.
229 <P>
230 <DL>
231 </DL>
232 </DL>
233 <HR>
234
235 <A NAME="TRY_HARDER"><!-- --></A><H3>
236 TRY_HARDER</H3>
237 <PRE>
238 public static final <A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A> <B>TRY_HARDER</B></PRE>
239 <DL>
240 <DD>Spend more time to try to find a barcode; optimize for accuracy, not speed.
241  Doesn't matter what it maps to; use <CODE>Boolean.TRUE</CODE>.
242 <P>
243 <DL>
244 </DL>
245 </DL>
246 <HR>
247
248 <A NAME="ALLOWED_LENGTHS"><!-- --></A><H3>
249 ALLOWED_LENGTHS</H3>
250 <PRE>
251 public static final <A HREF="../../../com/google/zxing/DecodeHintType.html" title="class in com.google.zxing">DecodeHintType</A> <B>ALLOWED_LENGTHS</B></PRE>
252 <DL>
253 <DD>Allowed lengths of encoded data -- reject anything else. Maps to an int[].
254 <P>
255 <DL>
256 </DL>
257 </DL>
258 <!-- ========= END OF CLASS DATA ========= -->
259 <HR>
260
261
262 <!-- ======= START OF BOTTOM NAVBAR ====== -->
263 <A NAME="navbar_bottom"><!-- --></A>
264 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
265 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
266 <TR>
267 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
268 <A NAME="navbar_bottom_firstrow"><!-- --></A>
269 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
270   <TR ALIGN="center" VALIGN="top">
271   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
272   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
273   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
274   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
275   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
276   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
277   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
278   </TR>
279 </TABLE>
280 </TD>
281 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
282 <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>
283 </TD>
284 </TR>
285
286 <TR>
287 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
288 &nbsp;<A HREF="../../../com/google/zxing/BlackPointEstimationMethod.html" title="class in com.google.zxing"><B>PREV CLASS</B></A>&nbsp;
289 &nbsp;<A HREF="../../../com/google/zxing/EncodeHintType.html" title="class in com.google.zxing"><B>NEXT CLASS</B></A></FONT></TD>
290 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
291   <A HREF="../../../index.html?com/google/zxing/DecodeHintType.html" target="_top"><B>FRAMES</B></A>  &nbsp;
292 &nbsp;<A HREF="DecodeHintType.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
293 &nbsp;<SCRIPT type="text/javascript">
294   <!--
295   if(window==top) {
296     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
297   }
298   //-->
299 </SCRIPT>
300 <NOSCRIPT>
301   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
302 </NOSCRIPT>
303
304
305 </FONT></TD>
306 </TR>
307 <TR>
308 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
309   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
310 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
311 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
312 </TR>
313 </TABLE>
314 <A NAME="skip-navbar_bottom"></A>
315 <!-- ======== END OF BOTTOM NAVBAR ======= -->
316
317 <HR>
318
319 </BODY>
320 </HTML>