# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

# CarrierIdentifier

`public class CarrierIdentifier`
`extends Object` `implements Parcelable`

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 `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 `android.os.Parcelable`
`int` | `CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` | `PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: 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 Creator<CarrierIdentifier>` | `CREATOR` Used to create a `CarrierIdentifier` from a `Parcel`.

### Public constructors
`CarrierIdentifier(String mcc, String mnc, String spn, String imsi, String gid1, String gid2)`
`CarrierIdentifier(String mcc, String mnc, String spn, String imsi, String gid1, String gid2, int carrierid, int specificCarrierId)`
`CarrierIdentifier(byte[] mccMnc, String gid1, String gid2)` Creates a carrier identifier instance.

### 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.
`int` | `getCarrierId()` Returns the carrier id.
`String` | `getGid1()` Get the group identifier level 1.
`String` | `getGid2()` Get the group identifier level 2.
`String` | `getImsi()` Get the international mobile subscriber identity.
`String` | `getMcc()` Get the mobile country code.
`String` | `getMnc()` Get the mobile network code.
`int` | `getSpecificCarrierId()` A specific carrier ID returns the fine-grained carrier ID of the current subscription.
`String` | `getSpn()` Get the service provider name.
`int` | `hashCode()` Returns a hash code value for the object.
`String` | `toString()` Returns a string representation of the object.
`void` | `writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
From interface `android.os.Parcelable`
`abstract int` | `describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void` | `writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

## Fields

### CREATOR

    public static final Creator<CarrierIdentifier> CREATOR

Used to create a `CarrierIdentifier` from a `Parcel`.

## Public constructors

### CarrierIdentifier

    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

    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 `TelephonyManager#getSubscriberId()` This value may be `null`.
`gid1` | `String`: group id level 1 `TelephonyManager#getGroupIdLevel1()` This value may be `null`.
`gid2` | `String`: group id level 2 This value may be `null`.
`carrierid` | `int`: carrier unique identifier `TelephonyManager#getSimCarrierId()`, used to uniquely identify the carrier and look up the carrier configurations.
`specificCarrierId` | `int`: specific carrier identifier `TelephonyManager#getSimSpecificCarrierId()`

### CarrierIdentifier

    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
`IllegalArgumentException` | If the length of `mccMnc` is not 3.

## Public methods

### describeContents

    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

    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`.

The `equals` method for class `Object` implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values `x` and `y`, this method returns `true` if and only if `x` and `y` refer to the same object (`x == y` has the value `true`).

Note that it is generally necessary to override the `hashCode` method whenever this method is overridden, so as to maintain the general contract for the `hashCode` method, which states that equal objects must have equal hash codes.

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

    public int getCarrierId ()

Returns the carrier id.

Returns
`int` |

See also:

- `TelephonyManager.getSimCarrierId()`

### getGid1

    public String getGid1 ()

Get the group identifier level 1.

Returns
`String` | This value may be `null`.

### getGid2

    public String getGid2 ()

Get the group identifier level 2.

Returns
`String` | This value may be `null`.

### getImsi

    public String getImsi ()

Get the international mobile subscriber identity.

Returns
`String` | This value may be `null`.

### getMcc

    public String getMcc ()

Get the mobile country code.

Returns
`String` |

### getMnc

    public String getMnc ()

Get the mobile network code.

Returns
`String` |

### getSpecificCarrierId

    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:

- `TelephonyManager.getSimSpecificCarrierId()`

### getSpn

    public String getSpn ()

Get the service provider name.

Returns
`String` | This value may be `null`.

### hashCode

    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(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 `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.

As much as is reasonably practical, the hashCode method defined by class `Object` does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int` | a hash code value for this object.

### toString

    public String toString ()

Returns a string representation of the object. In general, the `toString` method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The `toString` method for class `Object` returns a string consisting of the name of the class of which the object is an instance, the at-sign character ``@`', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

>      getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String` | a string representation of the object.

### writeToParcel

    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.
`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

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*