core/src/com/google/zxing/qrcode/decoder/Mode.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 import com.google.zxing.ReaderException;
  20
  21 /**
  22  * <p>See ISO 18004:2006, 6.4.1, Tables 2 and 3. This enum encapsulates the various modes in which
  23  * data can be encoded to bits in the QR code standard.</p>
  24  *
  25  * @author srowen@google.com (Sean Owen)
  26  */
  27 final class Mode {
  28
  29   // No, we can't use an enum here. J2ME doesn't support it.
  30
  31   static final Mode TERMINATOR = new Mode(new int[]{0, 0, 0}); // Not really a mode...
  32   static final Mode NUMERIC = new Mode(new int[]{10, 12, 14});
  33   static final Mode ALPHANUMERIC = new Mode(new int[]{9, 11, 13});
  34   static final Mode BYTE = new Mode(new int[]{8, 16, 16});
  35   static final Mode ECI = new Mode(null); // character counts don't apply
  36   static final Mode KANJI = new Mode(new int[]{8, 10, 12});
  37
  38   private final int[] characterCountBitsForVersions;
  39
  40   private Mode(int[] characterCountBitsForVersions) {
  41     this.characterCountBitsForVersions = characterCountBitsForVersions;
  42   }
  43
  44   /**
  45    * @param bits four bits encoding a QR Code data mode
  46    * @return {@link Mode} encoded by these bits
  47    * @throws ReaderException if bits do not correspond to a known mode
  48    */
  49   static Mode forBits(int bits) throws ReaderException {
  50     switch (bits) {
  51       case 0x0:
  52         return TERMINATOR;
  53       case 0x1:
  54         return NUMERIC;
  55       case 0x2:
  56         return ALPHANUMERIC;
  57       case 0x4:
  58         return BYTE;
  59       case 0x7:
  60         return ECI;
  61       case 0x8:
  62         return KANJI;
  63       default:
  64         throw new ReaderException("Illegal mode bits: " + bits);
  65     }
  66   }
  67
  68   /**
  69    * @param version version in question
  70    * @return number of bits used, in this QR Code symbol {@link Version}, to encode the
  71    *         count of characters that will follow encoded in this {@link Mode}
  72    */
  73   int getCharacterCountBits(Version version) {
  74     if (this == ECI) {
  75       throw new UnsupportedOperationException("Character count doesn't apply to ECI mode");
  76     }
  77     int number = version.getVersionNumber();
  78     int offset;
  79     if (number <= 9) {
  80       offset = 0;
  81     } else if (number <= 26) {
  82       offset = 1;
  83     } else {
  84       offset = 2;
  85     }
  86     return characterCountBitsForVersions[offset];
  87   }
  88
  89 }