git-svn-id: http://zxing.googlecode.com/svn/trunk@6 59b500cc-1b3d-0410-9834-0bbf25fbcc57
[zxing.git] / core / src / com / google / zxing / DecodeHintType.java
1 /*
2  * Copyright 2007 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.google.zxing;
18
19 /**
20  * Encapsulates a type of hint that a caller may pass to a barcode reader to help it
21  * more quickly or accurately decode it. It is up to implementations to decide what,
22  * if anything, to do with the information that is supplied.
23  *
24  * @author srowen@google.com (Sean Owen), dswitkin@google.com (Daniel Switkin)
25  * @see Reader#decode(MonochromeBitmapSource, java.util.Map)
26  */
27 public final class DecodeHintType {
28
29   // No, we can't use an enum here. J2ME doesn't support it.
30
31   /** Unspecified, application-specific hint. */
32   public static final DecodeHintType OTHER = new DecodeHintType();
33   /** Image is a pure monochrome image of a barcode. */
34   public static final DecodeHintType PURE_BARCODE = new DecodeHintType();
35   /**
36    * Image is known to be of one of a few possible formats.
37    * Maps to {@link java.util.Collection} of {@link BarcodeFormat}s.
38    */
39   public static final DecodeHintType POSSIBLE_FORMATS = new DecodeHintType();
40
41   private DecodeHintType() {}
42
43 }