NetworkScanRequest
public
final
class
NetworkScanRequest
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.telephony.NetworkScanRequest |
Defines a request to perform a network scan. This class defines whether the network scan will be performed only once or periodically until cancelled, when the scan is performed periodically, the time interval is not controlled by the user but defined by the modem vendor.
Summary
Constants | |
---|---|
int |
SCAN_TYPE_ONE_SHOT
Performs the scan only once |
int |
SCAN_TYPE_PERIODIC
Performs the scan periodically until cancelled The modem will start new scans periodically, and the interval between two scans is usually multiple minutes. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<NetworkScanRequest> |
CREATOR
|
Public constructors | |
---|---|
NetworkScanRequest(int scanType, RadioAccessSpecifier[] specifiers, int searchPeriodicity, int maxSearchTime, boolean incrementalResults, int incrementalResultsPeriodicity, ArrayList<String> mccMncs)
Creates a new NetworkScanRequest with mScanType and network mSpecifiers |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object other)
Indicates whether some other object is "equal to" this one. |
boolean
|
getIncrementalResults()
Returns whether incremental result is enabled. |
int
|
getIncrementalResultsPeriodicity()
Returns the periodicity in seconds of incremental results. |
int
|
getMaxSearchTime()
Returns maximum duration of the periodic search in seconds. |
ArrayList<String>
|
getPlmns()
Returns the List of PLMN ids (MCC-MNC) for early termination of scan. |
int
|
getScanType()
Returns the type of the scan. |
int
|
getSearchPeriodicity()
Returns the search periodicity in seconds. |
RadioAccessSpecifier[]
|
getSpecifiers()
Returns the radio access technologies with bands or channels that need to be scanned. |
int
|
hashCode()
Returns a hash code value for the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
SCAN_TYPE_ONE_SHOT
public static final int SCAN_TYPE_ONE_SHOT
Performs the scan only once
Constant Value: 0 (0x00000000)
SCAN_TYPE_PERIODIC
public static final int SCAN_TYPE_PERIODIC
Performs the scan periodically until cancelled The modem will start new scans periodically, and the interval between two scans is usually multiple minutes.
Constant Value: 1 (0x00000001)
Fields
Public constructors
NetworkScanRequest
public NetworkScanRequest (int scanType, RadioAccessSpecifier[] specifiers, int searchPeriodicity, int maxSearchTime, boolean incrementalResults, int incrementalResultsPeriodicity, ArrayList<String> mccMncs)
Creates a new NetworkScanRequest with mScanType and network mSpecifiers
Parameters | |
---|---|
scanType |
int : The type of the scan, can be either one shot or periodic |
specifiers |
RadioAccessSpecifier : the radio network with bands / channels to be scanned |
searchPeriodicity |
int : The modem will restart the scan every searchPeriodicity seconds if
no network has been found, until it reaches the maxSearchTime. Only
valid when scan type is periodic scan. |
maxSearchTime |
int : Maximum duration of the search (in seconds) |
incrementalResults |
boolean : Indicates whether the modem should report incremental
results of the network scan to the client |
incrementalResultsPeriodicity |
int : Indicates the periodicity with which the modem should
report incremental results to the client (in seconds),
only valid when incrementalResults is true |
mccMncs |
ArrayList : Describes the list of PLMN ids (MCC-MNC), once any network in the list has
been found, the scan will be terminated by the modem. |
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 other)
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 | |
---|---|
other |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getIncrementalResults
public boolean getIncrementalResults ()
Returns whether incremental result is enabled. FALSE \u2013 Incremental results is not enabled. TRUE \u2013 Incremental results is reported.
Returns | |
---|---|
boolean |
getIncrementalResultsPeriodicity
public int getIncrementalResultsPeriodicity ()
Returns the periodicity in seconds of incremental results.
Returns | |
---|---|
int |
getMaxSearchTime
public int getMaxSearchTime ()
Returns maximum duration of the periodic search in seconds.
Returns | |
---|---|
int |
getPlmns
public ArrayList<String> getPlmns ()
Returns the List of PLMN ids (MCC-MNC) for early termination of scan. If any PLMN of this list is found, search should end at that point and results with all PLMN found till that point should be sent as response.
Returns | |
---|---|
ArrayList<String> |
getScanType
public int getScanType ()
Returns the type of the scan.
Returns | |
---|---|
int |
Value is SCAN_TYPE_ONE_SHOT , or SCAN_TYPE_PERIODIC |
getSearchPeriodicity
public int getSearchPeriodicity ()
Returns the search periodicity in seconds.
Returns | |
---|---|
int |
getSpecifiers
public RadioAccessSpecifier[] getSpecifiers ()
Returns the radio access technologies with bands or channels that need to be scanned.
Returns | |
---|---|
RadioAccessSpecifier[] |
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. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
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 |