public class

ServiceState

extends Object
implements Parcelable
java.lang.Object
   ↳ android.telephony.ServiceState

Class Overview

Contains phone state and service related information. The following phone information is included in returned ServiceState:

  • Service state: IN_SERVICE, OUT_OF_SERVICE, EMERGENCY_ONLY, POWER_OFF
  • Roaming indicator
  • Operator name, short name and numeric id
  • Network selection mode

Summary

Constants
Creator<ServiceState> CREATOR
int STATE_EMERGENCY_ONLY The phone is registered and locked. Only emergency numbers are allowed.
int STATE_IN_SERVICE Normal operation condition, the phone is registered with an operator either in home network or in roaming.
int STATE_OUT_OF_SERVICE Phone is not registered with any operator, the phone can be currently searching a new operator to register to, or not searching to registration at all, or registration is denied, or radio signal is not available.
int STATE_POWER_OFF Radio of telephony is explictly powered off.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
ServiceState()
Empty constructor
ServiceState(ServiceState s)
Copy constructors
ServiceState(Parcel in)
Construct a ServiceState object from the given parcel.
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
boolean getIsManualSelection()
Get current network selection mode
String getOperatorAlphaLong()
Get current registered operator name in long alphanumeric format In GSM/UMTS, long format can be upto 16 characters long
String getOperatorAlphaShort()
Get current registered operator name in short lphanumeric format In GSM/UMST, short format can be upto 8 characters long
String getOperatorNumeric()
Get current registered operator numeric id In GSM/UMTS, numeric format is 3 digit country code plus 2 or 3 digit network code The country code can be decoded using MccTable.countryCodeForMcc()
boolean getRoaming()
Get current roaming indicator of phone (note: not just decoding from TS 27.007 7.2)
int getState()
Get current servcie state of phone
int hashCode()
Returns an integer hash code for this object.
void setIsManualSelection(boolean isManual)
void setOperatorName(String longName, String shortName, String numeric)
void setRoaming(boolean roaming)
void setState(int state)
void setStateOff()
void setStateOutOfService()
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.
Protected Methods
void copyFrom(ServiceState s)
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final Creator<ServiceState> CREATOR

public static final int STATE_EMERGENCY_ONLY

The phone is registered and locked. Only emergency numbers are allowed.

Constant Value: 2 (0x00000002)

public static final int STATE_IN_SERVICE

Normal operation condition, the phone is registered with an operator either in home network or in roaming.

Constant Value: 0 (0x00000000)

public static final int STATE_OUT_OF_SERVICE

Phone is not registered with any operator, the phone can be currently searching a new operator to register to, or not searching to registration at all, or registration is denied, or radio signal is not available.

Constant Value: 1 (0x00000001)

public static final int STATE_POWER_OFF

Radio of telephony is explictly powered off.

Constant Value: 3 (0x00000003)

Public Constructors

public ServiceState ()

Empty constructor

public ServiceState (ServiceState s)

Copy constructors

Parameters
s Source service state

public ServiceState (Parcel in)

Construct a ServiceState object from the given parcel.

Public Methods

public int describeContents ()

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be both transitive and reflexive.

The implementation in Object returns true only if o is the exact same object as the receiver (using the == operator for comparison). Subclasses often implement equals(Object) so that it takes into account the two object's types and states.

The general contract for the equals(Object) and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or none of them.

Parameters
o the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public boolean getIsManualSelection ()

Get current network selection mode

Returns
  • true if manual mode, false if automatic mode

public String getOperatorAlphaLong ()

Get current registered operator name in long alphanumeric format In GSM/UMTS, long format can be upto 16 characters long

Returns
  • long name of operator, null if unregistered or unknown

public String getOperatorAlphaShort ()

Get current registered operator name in short lphanumeric format In GSM/UMST, short format can be upto 8 characters long

Returns
  • short name of operator, null if unregistered or unknown

public String getOperatorNumeric ()

Get current registered operator numeric id In GSM/UMTS, numeric format is 3 digit country code plus 2 or 3 digit network code The country code can be decoded using MccTable.countryCodeForMcc()

Returns
  • numeric format of operator, null if unregistered or unknown

public boolean getRoaming ()

Get current roaming indicator of phone (note: not just decoding from TS 27.007 7.2)

Returns
  • true if TS 27.007 7.2 roaming is true and ONS is different from SPN

public int getState ()

Get current servcie state of phone

See Also

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Returns
  • this object's hash code.

public void setIsManualSelection (boolean isManual)

public void setOperatorName (String longName, String shortName, String numeric)

public void setRoaming (boolean roaming)

public void setState (int state)

public void setStateOff ()

public void setStateOutOfService ()

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation simply concatenates the class name, the '@' sign and a hexadecimal representation of the object's hashCode(), that is, it is equivalent to the following expression: 

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

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel out, int flags)

Flatten this object in to a Parcel.

Parameters
out The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Protected Methods

protected void copyFrom (ServiceState s)