public class

Criteria

extends Object
implements Parcelable

java.lang.Object
↳	android.location.Criteria

Class Overview

A class indicating the application criteria for selecting a location provider. Providers maybe ordered according to accuracy, power usage, ability to report altitude, speed, and bearing, and monetary cost.

Summary

Constants
int	ACCURACY_COARSE	A constant indicating an approximate accuracy requirement
int	ACCURACY_FINE	A constant indicating a finer location accuracy requirement
Creator<Criteria>	CREATOR
int	NO_REQUIREMENT	A constant indicating that the application does not choose to place requirement on a particular feature.
int	POWER_HIGH	A constant indicating a high power requirement.
int	POWER_LOW	A constant indicating a low power requirement.
int	POWER_MEDIUM	A constant indicating a medium power requirement.

[Expand]

Inherited Constants

From interface android.os.Parcelable

Public Constructors
	Criteria() Constructs a new Criteria object.
	Criteria(Criteria criteria) Constructs a new Criteria object that is a copy of the given criteria.

Public Methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
int	getAccuracy() Returns a constant indicating desired accuracy of location Accuracy may be ACCURACY_FINE if desired location is fine, else it can be ACCURACY_COARSE.
int	getPowerRequirement() Returns a constant indicating the desired power requirement.
boolean	isAltitudeRequired() Returns whether the provider must provide altitude information.
boolean	isBearingRequired() Returns whether the provider must provide bearing information.
boolean	isCostAllowed() Returns whether the provider is allowed to incur monetary cost.
boolean	isSpeedRequired() Returns whether the provider must provide speed information.
void	setAccuracy(int accuracy) Indicates the desired accuracy for latitude and longitude.
void	setAltitudeRequired(boolean altitudeRequired) Indicates whether the provider must provide altitude information.
void	setBearingRequired(boolean bearingRequired) Indicates whether the provider must provide bearing information.
void	setCostAllowed(boolean costAllowed) Indicates whether the provider is allowed to incur monetary cost.
void	setPowerRequirement(int level) Indicates the desired maximum power level.
void	setSpeedRequired(boolean speedRequired) Indicates whether the provider must provide speed information.
void	writeToParcel(Parcel parcel, int flags) Flatten this object in to a Parcel.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface android.os.Parcelable

Constants

public static final int ACCURACY_COARSE

A constant indicating an approximate accuracy requirement

Constant Value: 2 (0x00000002)

public static final int ACCURACY_FINE

A constant indicating a finer location accuracy requirement

Constant Value: 1 (0x00000001)

public static final Creator<Criteria> CREATOR

public static final int NO_REQUIREMENT

A constant indicating that the application does not choose to place requirement on a particular feature.

Constant Value: 0 (0x00000000)

public static final int POWER_HIGH

A constant indicating a high power requirement.

Constant Value: 3 (0x00000003)

public static final int POWER_LOW

A constant indicating a low power requirement.

Constant Value: 1 (0x00000001)

public static final int POWER_MEDIUM

A constant indicating a medium power requirement.

Constant Value: 2 (0x00000002)

Public Constructors

public Criteria ()

Constructs a new Criteria object. The new object will have no requirements on accuracy, power, or response time; will not require altitude, speed, or bearing; and will not allow monetary cost.

public Criteria (Criteria criteria)

Constructs a new Criteria object that is a copy of the given criteria.

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 int getAccuracy ()

Returns a constant indicating desired accuracy of location Accuracy may be ACCURACY_FINE if desired location is fine, else it can be ACCURACY_COARSE.

public int getPowerRequirement ()

Returns a constant indicating the desired power requirement. The returned

public boolean isAltitudeRequired ()

Returns whether the provider must provide altitude information. Not all fixes are guaranteed to contain such information.

public boolean isBearingRequired ()

Returns whether the provider must provide bearing information. Not all fixes are guaranteed to contain such information.

public boolean isCostAllowed ()

Returns whether the provider is allowed to incur monetary cost.

public boolean isSpeedRequired ()

Returns whether the provider must provide speed information. Not all fixes are guaranteed to contain such information.

public void setAccuracy (int accuracy)

Indicates the desired accuracy for latitude and longitude. Accuracy may be ACCURACY_FINE if desired location is fine, else it can be ACCURACY_COARSE. More accurate location usually consumes more power and may take longer.

Throws

IllegalArgumentException	if accuracy is negative

public void setAltitudeRequired (boolean altitudeRequired)

Indicates whether the provider must provide altitude information. Not all fixes are guaranteed to contain such information.

public void setBearingRequired (boolean bearingRequired)

Indicates whether the provider must provide bearing information. Not all fixes are guaranteed to contain such information.

public void setCostAllowed (boolean costAllowed)

Indicates whether the provider is allowed to incur monetary cost.

public void setPowerRequirement (int level)

Indicates the desired maximum power level. The level parameter must be one of NO_REQUIREMENT, POWER_LOW, POWER_MEDIUM, or POWER_HIGH.

public void setSpeedRequired (boolean speedRequired)

Indicates whether the provider must provide speed information. Not all fixes are guaranteed to contain such information.

public void writeToParcel (Parcel parcel, int flags)

Flatten this object in to a Parcel.

Parameters

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

Interfaces

Classes