Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#inhconstants) \| [Fields](https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#lfields) \| [Ctors](https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#pubctors) \| [Methods](https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#inhmethods)
# CarrierIdentifier
*** ** * ** ***
` public class CarrierIdentifier `
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.service.carrier.CarrierIdentifier |
*** ** * ** ***
Used to pass info to CarrierConfigService implementations so they can decide what values to return. Instead of passing mcc, mnc, gid1, gid2, spn, imsi to locate carrier information, CarrierIdentifier also include carrier id `https://developer.android.com/reference/android/telephony/TelephonyManager#getSimCarrierId()`, a platform-wide unique identifier for each carrier. CarrierConfigService can directly use carrier id as the key to look up the carrier info.
## Summary
### Inherited constants
From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`
Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`
Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".
| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator` | `https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#CREATOR` Used to create a `https://developer.android.com/reference/android/service/carrier/CarrierIdentifier` from a `https://developer.android.com/reference/android/os/Parcel`. |
| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#CarrierIdentifier(byte[],%20java.lang.String,%20java.lang.String)(byte[] mccMnc, https://developer.android.com/reference/java/lang/String gid1, https://developer.android.com/reference/java/lang/String gid2) ` Creates a carrier identifier instance. |
| ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#CarrierIdentifier(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String mcc, https://developer.android.com/reference/java/lang/String mnc, https://developer.android.com/reference/java/lang/String spn, https://developer.android.com/reference/java/lang/String imsi, https://developer.android.com/reference/java/lang/String gid1, https://developer.android.com/reference/java/lang/String gid2) ` |
| ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#CarrierIdentifier(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20int,%20int)(https://developer.android.com/reference/java/lang/String mcc, https://developer.android.com/reference/java/lang/String mnc, https://developer.android.com/reference/java/lang/String spn, https://developer.android.com/reference/java/lang/String imsi, https://developer.android.com/reference/java/lang/String gid1, https://developer.android.com/reference/java/lang/String gid2, int carrierid, int specificCarrierId) ` |
| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. |
| ` int` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getCarrierId()() ` Returns the carrier id. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getGid1()() ` Get the group identifier level 1. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getGid2()() ` Get the group identifier level 2. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getImsi()() ` Get the international mobile subscriber identity. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getMcc()() ` Get the mobile country code. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getMnc()() ` Get the mobile network code. |
| ` int` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getSpecificCarrierId()() ` A specific carrier ID returns the fine-grained carrier ID of the current subscription. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#getSpn()() ` Get the service provider name. |
| ` int` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/service/carrier/CarrierIdentifier#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel out, int flags) ` Flatten this object in to a Parcel. |
### Inherited methods
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `
Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `
Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class` ` https://developer.android.com/reference/java/lang/Object#getClass()() `
Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `
Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `
Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `
Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `
Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `
Flatten this object in to a Parcel.
## Fields
### CREATOR
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
Used to create a `https://developer.android.com/reference/android/service/carrier/CarrierIdentifier` from a `https://developer.android.com/reference/android/os/Parcel`.
## Public constructors
### CarrierIdentifier
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CarrierIdentifier (byte[] mccMnc,
String gid1,
String gid2)
```
Creates a carrier identifier instance.
| Parameters ||
|---|---|
| `mccMnc` | `byte`: A 3-byte array as defined by 3GPP TS 24.008.
|
| `gid1` | `String`: The group identifier level 1. This value may be `null`.
|
| `gid2` | `String`: The group identifier level 2. This value may be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | If the length of `mccMnc` is not 3. |
### CarrierIdentifier
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CarrierIdentifier (String mcc,
String mnc,
String spn,
String imsi,
String gid1,
String gid2)
```
| Parameters ||
|---|---|
| `mcc` | `String`
|
| `mnc` | `String`
|
| `spn` | `String`: This value may be `null`.
|
| `imsi` | `String`: This value may be `null`.
|
| `gid1` | `String`: This value may be `null`.
|
| `gid2` | `String`: This value may be `null`.
|
### CarrierIdentifier
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CarrierIdentifier (String mcc,
String mnc,
String spn,
String imsi,
String gid1,
String gid2,
int carrierid,
int specificCarrierId)
```
| Parameters ||
|---|---|
| `mcc` | `String`: mobile country code. This value cannot be `null`.
|
| `mnc` | `String`: mobile network code. This value cannot be `null`.
|
| `spn` | `String`: service provider name. This value may be `null`.
|
| `imsi` | `String`: International Mobile Subscriber Identity `https://developer.android.com/reference/android/telephony/TelephonyManager#getSubscriberId()` This value may be `null`.
|
| `gid1` | `String`: group id level 1 `https://developer.android.com/reference/android/telephony/TelephonyManager#getGroupIdLevel1()` This value may be `null`.
|
| `gid2` | `String`: group id level 2. This value may be `null`.
|
| `carrierid` | `int`: carrier unique identifier `https://developer.android.com/reference/android/telephony/TelephonyManager#getSimCarrierId()`, used to uniquely identify the carrier and look up the carrier configurations.
|
| `specificCarrierId` | `int`: specific carrier identifier `https://developer.android.com/reference/android/telephony/TelephonyManager#getSimSpecificCarrierId()`
|
## Public methods
### describeContents
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#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 - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |
### equals
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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`: the reference object with which to compare.
|
| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise.
|
### getCarrierId
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getCarrierId ()
```
Returns the carrier id.
| Returns ||
|---|---|
| `int` |
|
**See also:**
- `https://developer.android.com/reference/android/telephony/TelephonyManager#getSimCarrierId()`
### getGid1
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getGid1 ()
```
Get the group identifier level 1.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`.
|
### getGid2
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getGid2 ()
```
Get the group identifier level 2.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`.
|
### getImsi
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getImsi ()
```
Get the international mobile subscriber identity.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`.
|
### getMcc
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getMcc ()
```
Get the mobile country code.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` |
|
### getMnc
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getMnc ()
```
Get the mobile network code.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` |
|
### getSpecificCarrierId
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getSpecificCarrierId ()
```
A specific carrier ID returns the fine-grained carrier ID of the current subscription. It can represent the fact that a carrier may be in effect an aggregation of other carriers (ie in an MVNO type scenario) where each of these specific carriers which are used to make up the actual carrier service may have different carrier configurations. A specific carrier ID could also be used, for example, in a scenario where a carrier requires different carrier configuration for different service offering such as a prepaid plan.
| Returns ||
|---|---|
| `int` |
|
**See also:**
- `https://developer.android.com/reference/android/telephony/TelephonyManager#getSimSpecificCarrierId()`
### getSpn
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getSpn ()
```
Get the service provider name.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`.
|
### hashCode
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.
|
### toString
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object.
|
### writeToParcel
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel out,
int flags)
```
Flatten this object in to a Parcel.
| Parameters ||
|---|---|
| `out` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
|
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |