core/src/com/google/zxing/oned/OneDReader.java

   1 /*
   2  * Copyright 2008 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.oned;
  18
  19 import com.google.zxing.Reader;
  20 import com.google.zxing.ReaderException;
  21 import com.google.zxing.Result;
  22 import com.google.zxing.common.BitArray;
  23
  24 import java.util.Hashtable;
  25
  26 /**
  27  * <p>{@link Reader}s which also implement this interface read one-dimensional barcode
  28  * formats, and expose additional functionality that is specific to this type of barcode.</p>
  29  *
  30  * @author srowen@google.com (Sean Owen)
  31  */
  32 public interface OneDReader extends Reader {
  33
  34   /**
  35    * <p>Attempts to decode a one-dimensional barcode format given a single row of
  36    * an image.</p>
  37    *
  38    * @param rowNumber row number from top of the row
  39    * @param row the black/white pixel data of the row
  40    * @param hints decode hints
  41    * @return {@link Result} containing encoded string and start/end of barcode
  42    * @throws ReaderException if an error occurs or barcode cannot be found
  43    */
  44   Result decodeRow(int rowNumber, BitArray row, Hashtable hints) throws ReaderException;
  45
  46 }