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 |
---|
Fields | |
---|---|
public
static
final
Creator<CarrierIdentifier> |
CREATOR
Used to create a |
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 | |
---|---|
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
public int getCarrierId ()
Returns the carrier id.
Returns | |
---|---|
int |
See also:
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 . |
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 |
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 inequals
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 thehashCode
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 thehashCode
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
public String toString ()
Returns a string representation of the object.
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.
This value cannot 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 |