core/src/com/google/zxing/Result.java

   1 /*
   2  * Copyright 2007 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;
  18
  19 /**
  20  * <p>Encapsulates the result of decoding a barcode within an image.</p>
  21  *
  22  * @author srowen@google.com (Sean Owen)
  23  */
  24 public final class Result {
  25
  26   private final String text;
  27   private final ResultPoint[] resultPoints;
  28   private final BarcodeFormat format;
  29
  30   public Result(String text, ResultPoint[] resultPoints, BarcodeFormat format) {
  31     this.text = text;
  32     this.resultPoints = resultPoints;
  33     this.format = format;
  34   }
  35
  36   /**
  37    * @return raw text encoded by the barcode, if any
  38    */
  39   public String getText() {
  40     return text;
  41   }
  42
  43   /**
  44    * @return points related to the barcode in the image. These are typically points
  45    *         identifying finder patterns or the corners of the barcode. The exact meaning is
  46    *         specific to the type of barcode that was decoded.
  47    */
  48   public ResultPoint[] getResultPoints() {
  49     return resultPoints;
  50   }
  51
  52   /**
  53    * @return {@link BarcodeFormat} representing the format of the barcode that was recognized and decoded
  54    */
  55   public BarcodeFormat getBarcodeFormat() {
  56     return format;
  57   }
  58
  59 }