# Print output for @column tags ?>
public
final
class
NetworkScanRequest
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.telephony.NetworkScanRequest |
Defines a request to peform 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.
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 o)
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 | |
---|---|
public static final int SCAN_TYPE_ONE_SHOT
Performs the scan only once
Constant Value: 0 (0x00000000)
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)
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 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 |
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
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 | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public boolean getIncrementalResults ()
Returns whether incremental result is enabled. FALSE – Incremental results is not enabled. TRUE – Incremental results is reported.
Returns | |
---|---|
boolean |
public int getIncrementalResultsPeriodicity ()
Returns the periodicity in seconds of incremental results.
Returns | |
---|---|
int |
public int getMaxSearchTime ()
Returns maximum duration of the periodic search in seconds.
Returns | |
---|---|
int |
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> |
public int getScanType ()
Returns the type of the scan.
Returns | |
---|---|
int |
Value is SCAN_TYPE_ONE_SHOT , or SCAN_TYPE_PERIODIC |
public int getSearchPeriodicity ()
Returns the search periodicity in seconds.
Returns | |
---|---|
int |
public RadioAccessSpecifier[] getSpecifiers ()
Returns the radio access technologies with bands or channels that need to be scanned.
Returns | |
---|---|
RadioAccessSpecifier[] |
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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
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. |
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. |
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 |