core/src/com/google/zxing/qrcode/decoder/ErrorCorrectionLevel.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.qrcode.decoder;
  18
  19 /**
  20  * <p>See ISO 18004:2006, 6.5.1. This enum encapsulates the four error correction levels
  21  * defined by the QR code standard.</p>
  22  *
  23  * @author srowen@google.com (Sean Owen)
  24  */
  25 final class ErrorCorrectionLevel {
  26
  27   // No, we can't use an enum here. J2ME doesn't support it.
  28
  29   /**
  30    * L = ~7% correction
  31    */
  32   static final ErrorCorrectionLevel L = new ErrorCorrectionLevel(0);
  33   /**
  34    * M = ~15% correction
  35    */
  36   static final ErrorCorrectionLevel M = new ErrorCorrectionLevel(1);
  37   /**
  38    * Q = ~25% correction
  39    */
  40   static final ErrorCorrectionLevel Q = new ErrorCorrectionLevel(2);
  41   /**
  42    * H = ~30% correction
  43    */
  44   static final ErrorCorrectionLevel H = new ErrorCorrectionLevel(3);
  45
  46   private static final ErrorCorrectionLevel[] FOR_BITS = new ErrorCorrectionLevel[]{M, L, H, Q};
  47
  48   private final int ordinal;
  49
  50   private ErrorCorrectionLevel(int ordinal) {
  51     this.ordinal = ordinal;
  52   }
  53
  54   int ordinal() {
  55     return ordinal;
  56   }
  57
  58   /**
  59    * @param bits int containing the two bits encoding a QR Code's error correction level
  60    * @return {@link ErrorCorrectionLevel} representing the encoded error correction level
  61    */
  62   static ErrorCorrectionLevel forBits(int bits) {
  63     return FOR_BITS[bits];
  64   }
  65
  66
  67 }