Pileus Git - ~andy/freeotp/blob - src/com/google/zxing/Reader.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.Map;
  20
  21 /**
  22  * Implementations of this interface can decode an image of a barcode in some format into
  23  * the String it encodes. For example, {@link com.google.zxing.qrcode.QRCodeReader} can
  24  * decode a QR code. The decoder may optionally receive hints from the caller which may help
  25  * it decode more quickly or accurately.
  26  *
  27  * See {@link com.google.zxing.MultiFormatReader}, which attempts to determine what barcode
  28  * format is present within the image as well, and then decodes it accordingly.
  29  *
  30  * @author Sean Owen
  31  * @author dswitkin@google.com (Daniel Switkin)
  32  */
  33 public interface Reader {
  34
  35   /**
  36    * Locates and decodes a barcode in some format within an image.
  37    *
  38    * @param image image of barcode to decode
  39    * @return String which the barcode encodes
  40    * @throws NotFoundException if the barcode cannot be located or decoded for any reason
  41    */
  42   Result decode(BinaryBitmap image) throws NotFoundException, ChecksumException, FormatException;
  43
  44   /**
  45    * Locates and decodes a barcode in some format within an image. This method also accepts
  46    * hints, each possibly associated to some data, which may help the implementation decode.
  47    *
  48    * @param image image of barcode to decode
  49    * @param hints passed as a {@link java.util.Map} from {@link com.google.zxing.DecodeHintType}
  50    * to arbitrary data. The
  51    * meaning of the data depends upon the hint type. The implementation may or may not do
  52    * anything with these hints.
  53    * @return String which the barcode encodes
  54    * @throws NotFoundException if the barcode cannot be located or decoded for any reason
  55    */
  56   Result decode(BinaryBitmap image, Map<DecodeHintType,?> hints)
  57       throws NotFoundException, ChecksumException, FormatException;
  58
  59   /**
  60    * Resets any internal state the implementation has after a decode, to prepare it
  61    * for reuse.
  62    */
  63   void reset();
  64
  65 }