Pileus Git - ~andy/freeotp/blob - 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 import java.util.List;
  20
  21 /**
  22  * Encapsulates a type of hint that a caller may pass to a barcode reader to help it
  23  * more quickly or accurately decode it. It is up to implementations to decide what,
  24  * if anything, to do with the information that is supplied.
  25  *
  26  * @author Sean Owen
  27  * @author dswitkin@google.com (Daniel Switkin)
  28  * @see Reader#decode(BinaryBitmap,java.util.Map)
  29  */
  30 public enum DecodeHintType {
  31
  32   /**
  33    * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
  34    */
  35  OTHER(Object.class),
  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   PURE_BARCODE(Void.class),
  42
  43   /**
  44    * Image is known to be of one of a few possible formats.
  45    * Maps to a {@link List} of {@link BarcodeFormat}s.
  46    */
  47   POSSIBLE_FORMATS(List.class),
  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   TRY_HARDER(Void.class),
  54
  55   /**
  56    * Specifies what character encoding to use when decoding, where applicable (type String)
  57    */
  58   CHARACTER_SET(String.class),
  59
  60   /**
  61    * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
  62    */
  63   ALLOWED_LENGTHS(int[].class),
  64
  65   /**
  66    * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
  67    * use {@link Boolean#TRUE}.
  68    */
  69   ASSUME_CODE_39_CHECK_DIGIT(Void.class),
  70
  71   /**
  72    * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
  73    * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
  74    * use {@link Boolean#TRUE}.
  75    */
  76   ASSUME_GS1(Void.class),
  77
  78   /**
  79    * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
  80    * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
  81    * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
  82    */
  83   RETURN_CODABAR_START_END(Void.class),
  84
  85   /**
  86    * The caller needs to be notified via callback when a possible {@link ResultPoint}
  87    * is found. Maps to a {@link ResultPointCallback}.
  88    */
  89   NEED_RESULT_POINT_CALLBACK(ResultPointCallback.class),
  90
  91   // End of enumeration values.
  92   ;
  93
  94   /**
  95    * Data type the hint is expecting.
  96    * Among the possible values the {@link Void} stands out as being used for
  97    * hints that do not expect a value to be supplied (flag hints). Such hints
  98    * will possibly have their value ignored, or replaced by a
  99    * {@link Boolean#TRUE}. Hint suppliers should probably use
 100    * {@link Boolean#TRUE} as directed by the actual hint documentation.
 101    */
 102   private final Class<?> valueType;
 103
 104   DecodeHintType(Class<?> valueType) {
 105     this.valueType = valueType;
 106   }
 107
 108   public Class<?> getValueType() {
 109     return valueType;
 110   }
 111
 112 }