Pileus Git - ~andy/freeotp/blob - src/com/google/zxing/ResultMetadataType.java

   1 /*
   2  * Copyright 2008 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  * Represents some type of metadata about the result of the decoding that the decoder
  21  * wishes to communicate back to the caller.
  22  *
  23  * @author Sean Owen
  24  */
  25 public enum ResultMetadataType {
  26
  27   /**
  28    * Unspecified, application-specific metadata. Maps to an unspecified {@link Object}.
  29    */
  30   OTHER,
  31
  32   /**
  33    * Denotes the likely approximate orientation of the barcode in the image. This value
  34    * is given as degrees rotated clockwise from the normal, upright orientation.
  35    * For example a 1D barcode which was found by reading top-to-bottom would be
  36    * said to have orientation "90". This key maps to an {@link Integer} whose
  37    * value is in the range [0,360).
  38    */
  39   ORIENTATION,
  40
  41   /**
  42    * <p>2D barcode formats typically encode text, but allow for a sort of 'byte mode'
  43    * which is sometimes used to encode binary data. While {@link Result} makes available
  44    * the complete raw bytes in the barcode for these formats, it does not offer the bytes
  45    * from the byte segments alone.</p>
  46    *
  47    * <p>This maps to a {@link java.util.List} of byte arrays corresponding to the
  48    * raw bytes in the byte segments in the barcode, in order.</p>
  49    */
  50   BYTE_SEGMENTS,
  51
  52   /**
  53    * Error correction level used, if applicable. The value type depends on the
  54    * format, but is typically a String.
  55    */
  56   ERROR_CORRECTION_LEVEL,
  57
  58   /**
  59    * For some periodicals, indicates the issue number as an {@link Integer}.
  60    */
  61   ISSUE_NUMBER,
  62
  63   /**
  64    * For some products, indicates the suggested retail price in the barcode as a
  65    * formatted {@link String}.
  66    */
  67   SUGGESTED_PRICE ,
  68
  69   /**
  70    * For some products, the possible country of manufacture as a {@link String} denoting the
  71    * ISO country code. Some map to multiple possible countries, like "US/CA".
  72    */
  73   POSSIBLE_COUNTRY,
  74
  75   /**
  76    * For some products, the extension text
  77    */
  78   UPC_EAN_EXTENSION,
  79
  80   /**
  81    * PDF417-specific metadata
  82    */
  83   PDF417_EXTRA_METADATA,
  84
  85 }