ProviderProperties
public
final
class
ProviderProperties
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.location.provider.ProviderProperties |
Location provider properties.
Summary
Nested classes | |
|---|---|
class |
ProviderProperties.Builder
Builder for ProviderProperties. |
Constants | |
|---|---|
int |
ACCURACY_COARSE
A constant indicating a coarser location accuracy. |
int |
ACCURACY_FINE
A constant indicating a finer location accuracy. |
int |
POWER_USAGE_HIGH
A constant indicating high power usage. |
int |
POWER_USAGE_LOW
A constant indicating low power usage. |
int |
POWER_USAGE_MEDIUM
A constant indicating a medium power usage. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<ProviderProperties> |
CREATOR
|
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. |
int
|
getAccuracy()
Rough location accuracy for this provider, primarily with respect to horizontal location accuracy. |
int
|
getPowerUsage()
Power usage for this provider. |
boolean
|
hasAltitudeSupport()
True if the provider is able to provide altitude under at least some conditions. |
boolean
|
hasBearingSupport()
True if the provider is able to provide bearing under at least some conditions. |
boolean
|
hasCellRequirement()
True if the provider requires access to a cellular network (e.g., for cell tower IDs). |
boolean
|
hasMonetaryCost()
True if this provider may result in a monetary charge to the user. |
boolean
|
hasNetworkRequirement()
True if provider requires access to a data network (e.g., the Internet). |
boolean
|
hasSatelliteRequirement()
True if the provider requires access to a satellite-based positioning system (e.g., GPS). |
boolean
|
hasSpeedSupport()
True if the provider is able to provide speed under at least some conditions. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
ACCURACY_COARSE
public static final int ACCURACY_COARSE
A constant indicating a coarser location accuracy.
Constant Value: 2 (0x00000002)
ACCURACY_FINE
public static final int ACCURACY_FINE
A constant indicating a finer location accuracy.
Constant Value: 1 (0x00000001)
POWER_USAGE_HIGH
public static final int POWER_USAGE_HIGH
A constant indicating high power usage.
Constant Value: 3 (0x00000003)
POWER_USAGE_LOW
public static final int POWER_USAGE_LOW
A constant indicating low power usage.
Constant Value: 1 (0x00000001)
POWER_USAGE_MEDIUM
public static final int POWER_USAGE_MEDIUM
A constant indicating a medium power usage.
Constant Value: 2 (0x00000002)
Fields
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 o)
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
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
getAccuracy
public int getAccuracy ()
Rough location accuracy for this provider, primarily with respect to horizontal location accuracy.
| Returns | |
|---|---|
int |
Value is ACCURACY_FINE, or ACCURACY_COARSE |
getPowerUsage
public int getPowerUsage ()
Power usage for this provider.
| Returns | |
|---|---|
int |
Value is POWER_USAGE_LOW, POWER_USAGE_MEDIUM, or POWER_USAGE_HIGH |
hasAltitudeSupport
public boolean hasAltitudeSupport ()
True if the provider is able to provide altitude under at least some conditions.
| Returns | |
|---|---|
boolean |
|
hasBearingSupport
public boolean hasBearingSupport ()
True if the provider is able to provide bearing under at least some conditions.
| Returns | |
|---|---|
boolean |
|
hasCellRequirement
public boolean hasCellRequirement ()
True if the provider requires access to a cellular network (e.g., for cell tower IDs).
| Returns | |
|---|---|
boolean |
|
hasMonetaryCost
public boolean hasMonetaryCost ()
True if this provider may result in a monetary charge to the user. Network usage is not considered a monetary cost.
| Returns | |
|---|---|
boolean |
|
hasNetworkRequirement
public boolean hasNetworkRequirement ()
True if provider requires access to a data network (e.g., the Internet).
| Returns | |
|---|---|
boolean |
|
hasSatelliteRequirement
public boolean hasSatelliteRequirement ()
True if the provider requires access to a satellite-based positioning system (e.g., GPS).
| Returns | |
|---|---|
boolean |
|
hasSpeedSupport
public boolean hasSpeedSupport ()
True if the provider is able to provide speed under at least some conditions.
| Returns | |
|---|---|
boolean |
|
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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 thehashCodemethod 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 thehashCodemethod 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. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)
| 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 parcel, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
parcel |
Parcel: 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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-02-08 UTC.