UiccPortInfo

public final class UiccPortInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.UiccPortInfo


UiccPortInfo class represents information about a single port contained on UiccCardInfo. Per GSMA SGP.22 V3.0, a port is a logical entity to which an active UICC profile can be bound on a UICC card. If UICC supports 2 ports, then the port index is numbered 0,1. Each port index is unique within an UICC, but not necessarily unique across UICC\u2019s. For UICC's does not support MEP(Multi-enabled profile) PackageManager.FEATURE_TELEPHONY_EUICC_MEP, just return the default port index 0.

Summary

Constants

String ICCID_REDACTED

A redacted String if caller does not have permission to read ICCID.

Inherited constants

Fields

public static final Creator<UiccPortInfo> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

String getIccId()

Get the ICCID of the profile associated with this port.

int getLogicalSlotIndex()

Gets logical slot index for the slot that the UICC is currently attached.

int getPortIndex()

The port index is an enumeration of the ports available on the UICC.

int hashCode()

Returns a hash code value for the object.

boolean isActive()
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

ICCID_REDACTED

Added in API level 33
public static final String ICCID_REDACTED

A redacted String if caller does not have permission to read ICCID.

Constant Value: "FFFFFFFFFFFFFFFFFFFF"

Fields

CREATOR

Added in API level 33
public static final Creator<UiccPortInfo> CREATOR

Public methods

describeContents

Added in API level 33
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 33
public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getIccId

Added in API level 33
public String getIccId ()

Get the ICCID of the profile associated with this port. If this port is not isActive(), returns null. If the caller does not have access to the ICCID for this port, it will be redacted and ICCID_REDACTED will be returned.

Returns
String

getLogicalSlotIndex

Added in API level 33
public int getLogicalSlotIndex ()

Gets logical slot index for the slot that the UICC is currently attached. Logical slot index or ID: unique index referring to a logical SIM slot. Logical slot IDs start at 0 and go up depending on the number of supported active slots on a device. For example, a dual-SIM device typically has slot 0 and slot 1. If a device has multiple physical slots but only supports one active slot, it will have only the logical slot ID 0.

Returns
int the logical slot index for UICC port, if there is no logical slot index it returns SubscriptionManager#INVALID_SIM_SLOT_INDEX Value is 0 or greater

getPortIndex

Added in API level 33
public int getPortIndex ()

The port index is an enumeration of the ports available on the UICC. Example: if eUICC1 supports 2 ports, then the port index is numbered 0,1. Each port index is unique within an UICC, but not necessarily unique across UICC\u2019s. For UICC's does not support MEP(Multi-enabled profile), just return the default port index 0.

Returns
int Value is 0 or greater

hashCode

Added in API level 33
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

isActive

Added in API level 33
public boolean isActive ()

Returns
boolean true if port was tied to a modem stack.

toString

Added in API level 33
public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 33
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value may be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES