core/src/com/google/zxing/DecodeHintType.java

   1 /*
   2  * Copyright 2007 ZXing authors
   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 Sean Owen
  25  * @author dswitkin@google.com (Daniel Switkin)
  26  * @see Reader#decode(BinaryBitmap,java.util.Hashtable)
  27  */
  28 public final class DecodeHintType {
  29
  30   // No, we can't use an enum here. J2ME doesn't support it.
  31
  32   /**
  33    * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
  34    */
  35   public static final DecodeHintType OTHER = new DecodeHintType();
  36
  37   /**
  38    * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
  39    * use {@link Boolean#TRUE}.
  40    */
  41   public static final DecodeHintType PURE_BARCODE = new DecodeHintType();
  42
  43   /**
  44    * Image is known to be of one of a few possible formats.
  45    * Maps to a {@link java.util.Vector} of {@link BarcodeFormat}s.
  46    */
  47   public static final DecodeHintType POSSIBLE_FORMATS = new DecodeHintType();
  48
  49   /**
  50    * Spend more time to try to find a barcode; optimize for accuracy, not speed.
  51    * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
  52    */
  53   public static final DecodeHintType TRY_HARDER = new DecodeHintType();
  54
  55   /**
  56    * Specifies what character encoding to use when decoding, where applicable (type String)
  57    */
  58   public static final DecodeHintType CHARACTER_SET = new DecodeHintType();
  59
  60   /**
  61    * Allowed lengths of encoded data -- reject anything else. Maps to an int[].
  62    */
  63   public static final DecodeHintType ALLOWED_LENGTHS = new DecodeHintType();
  64
  65   /**
  66    * Assume Code 39 codes employ a check digit. Maps to {@link Boolean}.
  67    */
  68   public static final DecodeHintType ASSUME_CODE_39_CHECK_DIGIT = new DecodeHintType();
  69
  70   /**
  71    * The caller needs to be notified via callback when a possible {@link ResultPoint}
  72    * is found. Maps to a {@link ResultPointCallback}.
  73    */
  74   public static final DecodeHintType NEED_RESULT_POINT_CALLBACK = new DecodeHintType();
  75
  76   private DecodeHintType() {
  77   }
  78
  79 }