csharp/Reader.cs

   1 /*\r
   2 * Licensed under the Apache License, Version 2.0 (the "License");\r
   3 * you may not use this file except in compliance with the License.\r
   4 * You may obtain a copy of the License at\r
   5 *\r
   6 *      http://www.apache.org/licenses/LICENSE-2.0\r
   7 *\r
   8 * Unless required by applicable law or agreed to in writing, software\r
   9 * distributed under the License is distributed on an "AS IS" BASIS,\r
  10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  11 * See the License for the specific language governing permissions and\r
  12 * limitations under the License.\r
  13 */\r
  14 \r
  15 using System;\r
  16 using System.Collections;\r
  17 \r
  18 namespace com.google.zxing\r
  19 {\r
  20     public interface Reader\r
  21     { \r
  22         /**\r
  23        * Locates and decodes a barcode in some format within an image.\r
  24        *\r
  25        * @param image image of barcode to decode\r
  26        * @return String which the barcode encodes\r
  27        * @throws ReaderException if the barcode cannot be located or decoded for any reason\r
  28        */\r
  29       Result decode(MonochromeBitmapSource image);\r
  30 \r
  31       /**\r
  32        * Locates and decodes a barcode in some format within an image. This method also accepts\r
  33        * hints, each possibly associated to some data, which may help the implementation decode.\r
  34        *\r
  35        * @param image image of barcode to decode\r
  36        * @param hints passed as a {@link Hashtable} from {@link DecodeHintType} to aribtrary data. The\r
  37        * meaning of the data depends upon the hint type. The implementation may or may not do\r
  38        * anything with these hints.\r
  39        * @return String which the barcode encodes\r
  40        * @throws ReaderException if the barcode cannot be located or decoded for any reason\r
  41        */\r
  42       Result decode(MonochromeBitmapSource image, Hashtable hints);        \r
  43     }\r
  44 \r
  45 }