android.location
Class Criteria

java.lang.Object
  android.location.Criteria

All Implemented Interfaces:

Parcelable

public class Criteria
extends Object
implements Parcelable

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.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.Creator<T>

Field Summary

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

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Criteria()
Constructs a new Criteria object.

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

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_REQUIREMENT

public static final int NO_REQUIREMENT

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

See Also:

Constant Field Values

POWER_LOW

public static final int POWER_LOW

A constant indicating a low power requirement.

See Also:

Constant Field Values

POWER_MEDIUM

public static final int POWER_MEDIUM

A constant indicating a medium power requirement.

See Also:

Constant Field Values

POWER_HIGH

public static final int POWER_HIGH

A constant indicating a high power requirement.

See Also:

Constant Field Values

ACCURACY_FINE

public static final int ACCURACY_FINE

A constant indicating a finer location accuracy requirement

See Also:

Constant Field Values

ACCURACY_COARSE

public static final int ACCURACY_COARSE

A constant indicating an approximate accuracy requirement

See Also:

Constant Field Values

CREATOR

public static final Parcelable.Creator<Criteria> CREATOR

Constructor Detail

Criteria

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.

Criteria

public Criteria(Criteria criteria)

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

Method Detail

setAccuracy

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

getAccuracy

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.

setPowerRequirement

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.

getPowerRequirement

public int getPowerRequirement()

Returns a constant indicating the desired power requirement. The returned

setCostAllowed

public void setCostAllowed(boolean costAllowed)

Indicates whether the provider is allowed to incur monetary cost.

isCostAllowed

public boolean isCostAllowed()

Returns whether the provider is allowed to incur monetary cost.

setAltitudeRequired

public void setAltitudeRequired(boolean altitudeRequired)

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

isAltitudeRequired

public boolean isAltitudeRequired()

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

setSpeedRequired

public void setSpeedRequired(boolean speedRequired)

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

isSpeedRequired

public boolean isSpeedRequired()

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

setBearingRequired

public void setBearingRequired(boolean bearingRequired)

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

isBearingRequired

public boolean isBearingRequired()

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

describeContents

public int describeContents()

Description copied from interface: Parcelable

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Specified by:

describeContents in interface Parcelable

Returns:

a bitmask indicating the set of special object types marshalled by the Parcelable.

writeToParcel

public void writeToParcel(Parcel parcel,
                          int flags)

Description copied from interface: Parcelable

Flatten this object in to a Parcel.

Specified by:

writeToParcel in interface Parcelable

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