content: /*
   * Copyright (C) 2012 The Android Open Source Project
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package com.android.internal.telephony;
  
  import android.telephony.TelephonyManager;
  
  /**
   * {@hide}
   */
  public class IccCardConstants {
  
      /* The extra data for broadcasting intent INTENT_ICC_STATE_CHANGE */
      public static final String INTENT_KEY_ICC_STATE = "ss";
      /* UNKNOWN means the ICC state is unknown */
      public static final String INTENT_VALUE_ICC_UNKNOWN = "UNKNOWN";
      /* NOT_READY means the ICC interface is not ready (eg, radio is off or powering on) */
      public static final String INTENT_VALUE_ICC_NOT_READY = "NOT_READY";
      /* ABSENT means ICC is missing */
      public static final String INTENT_VALUE_ICC_ABSENT = "ABSENT";
      /* PRESENT means ICC is present */
      public static final String INTENT_VALUE_ICC_PRESENT = "PRESENT";
      /* CARD_IO_ERROR means for three consecutive times there was SIM IO error */
      static public final String INTENT_VALUE_ICC_CARD_IO_ERROR = "CARD_IO_ERROR";
      /* CARD_RESTRICTED means card is present but not usable due to carrier restrictions */
      static public final String INTENT_VALUE_ICC_CARD_RESTRICTED = "CARD_RESTRICTED";
      /* LOCKED means ICC is locked by pin or by network */
      public static final String INTENT_VALUE_ICC_LOCKED = "LOCKED";
      /* READY means ICC is ready to access */
      public static final String INTENT_VALUE_ICC_READY = "READY";
      /* IMSI means ICC IMSI is ready in property */
      public static final String INTENT_VALUE_ICC_IMSI = "IMSI";
      /* LOADED means all ICC records, including IMSI, are loaded */
      public static final String INTENT_VALUE_ICC_LOADED = "LOADED";
      /* The extra data for broadcasting intent INTENT_ICC_STATE_CHANGE */
      public static final String INTENT_KEY_LOCKED_REASON = "reason";
      /* PIN means ICC is locked on PIN1 */
      public static final String INTENT_VALUE_LOCKED_ON_PIN = "PIN";
      /* PUK means ICC is locked on PUK1 */
      public static final String INTENT_VALUE_LOCKED_ON_PUK = "PUK";
      /* NETWORK means ICC is locked on NETWORK PERSONALIZATION */
      public static final String INTENT_VALUE_LOCKED_NETWORK = "NETWORK";
      /* PERM_DISABLED means ICC is permanently disabled due to puk fails */
      public static final String INTENT_VALUE_ABSENT_ON_PERM_DISABLED = "PERM_DISABLED";
  
      /**
       * This is combination of IccCardStatus.CardState and IccCardApplicationStatus.AppState
       * for external apps (like PhoneApp) to use
       *
       * UNKNOWN is a transient state, for example, after user inputs ICC pin under
       * PIN_REQUIRED state, the query for ICC status returns UNKNOWN before it
       * turns to READY
       *
       * The ordinal values much match {@link TelephonyManager#SIM_STATE_UNKNOWN} ...
       */
      public enum State {
          UNKNOWN,        /** ordinal(0) == {@See TelephonyManager#SIM_STATE_UNKNOWN} */
          ABSENT,         /** ordinal(1) == {@See TelephonyManager#SIM_STATE_ABSENT} */
          PIN_REQUIRED,   /** ordinal(2) == {@See TelephonyManager#SIM_STATE_PIN_REQUIRED} */
          PUK_REQUIRED,   /** ordinal(3) == {@See TelephonyManager#SIM_STATE_PUK_REQUIRED} */
          NETWORK_LOCKED, /** ordinal(4) == {@See TelephonyManager#SIM_STATE_NETWORK_LOCKED} */
          READY,          /** ordinal(5) == {@See TelephonyManager#SIM_STATE_READY} */
          NOT_READY,      /** ordinal(6) == {@See TelephonyManager#SIM_STATE_NOT_READY} */
          PERM_DISABLED,  /** ordinal(7) == {@See TelephonyManager#SIM_STATE_PERM_DISABLED} */
          CARD_IO_ERROR,  /** ordinal(8) == {@See TelephonyManager#SIM_STATE_CARD_IO_ERROR} */
          CARD_RESTRICTED,/** ordinal(9) == {@See TelephonyManager#SIM_STATE_CARD_RESTRICTED} */
          LOADED;         /** ordinal(9) == {@See TelephonyManager#SIM_STATE_LOADED} */
  
          public boolean isPinLocked() {
              return ((this == PIN_REQUIRED) || (this == PUK_REQUIRED));
          }
  
          public boolean iccCardExist() {
              return ((this == PIN_REQUIRED) || (this == PUK_REQUIRED)
                      || (this == NETWORK_LOCKED) || (this == READY) || (this == NOT_READY)
                      || (this == PERM_DISABLED) || (this == CARD_IO_ERROR)
                      || (this == CARD_RESTRICTED) || (this == LOADED));
          }
  
          public static State intToState(int state) throws IllegalArgumentException {
              switch(state) {
                  case 0: return UNKNOWN;
                  case 1: return ABSENT;
                  case 2: return PIN_REQUIRED;
                  case 3: return PUK_REQUIRED;
                  case 4: return NETWORK_LOCKED;
                  case 5: return READY;
                  case 6: return NOT_READY;
                  case 7: return PERM_DISABLED;
                  case 8: return CARD_IO_ERROR;
                  case 9: return CARD_RESTRICTED;
                  case 10: return LOADED;
                  default:
                      throw new IllegalArgumentException();
              }
          }
      }
  }
  