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

Added in API level 31
public static final int ACCURACY_COARSE

A constant indicating a coarser location accuracy.

Constant Value: 2 (0x00000002)

ACCURACY_FINE

Added in API level 31
public static final int ACCURACY_FINE

A constant indicating a finer location accuracy.

Constant Value: 1 (0x00000001)

POWER_USAGE_HIGH

Added in API level 31
public static final int POWER_USAGE_HIGH

A constant indicating high power usage.

Constant Value: 3 (0x00000003)

POWER_USAGE_LOW

Added in API level 31
public static final int POWER_USAGE_LOW

A constant indicating low power usage.

Constant Value: 1 (0x00000001)

POWER_USAGE_MEDIUM

Added in API level 31
public static final int POWER_USAGE_MEDIUM

A constant indicating a medium power usage.

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 31
public static final Creator<ProviderProperties> CREATOR

Public methods

describeContents

Added in API level 31
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

Added in API level 31
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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values 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.
  • For any non-null reference value x, x.equals(null) should return false.

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
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

Added in API level 31
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

Added in API level 31
public int getPowerUsage ()

Power usage for this provider.

Returns
int Value is POWER_USAGE_LOW, POWER_USAGE_MEDIUM, or POWER_USAGE_HIGH

hasAltitudeSupport

Added in API level 31
public boolean hasAltitudeSupport ()

True if the provider is able to provide altitude under at least some conditions.

Returns
boolean

hasBearingSupport

Added in API level 31
public boolean hasBearingSupport ()

True if the provider is able to provide bearing under at least some conditions.

Returns
boolean

hasCellRequirement

Added in API level 31
public boolean hasCellRequirement ()

True if the provider requires access to a cellular network (e.g., for cell tower IDs).

Returns
boolean

hasMonetaryCost

Added in API level 31
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

Added in API level 31
public boolean hasNetworkRequirement ()

True if provider requires access to a data network (e.g., the Internet).

Returns
boolean

hasSatelliteRequirement

Added in API level 31
public boolean hasSatelliteRequirement ()

True if the provider requires access to a satellite-based positioning system (e.g., GPS).

Returns
boolean

hasSpeedSupport

Added in API level 31
public boolean hasSpeedSupport ()

True if the provider is able to provide speed under at least some conditions.

Returns
boolean

hashCode

Added in API level 31
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 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.
  • If two objects are equal according to the equals method, then calling the hashCode 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 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.

Returns
int a hash code value for this object.

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31
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