com.mapbox.mapboxsdk.location.engine

Class LocationEngineResult

java.lang.Object

com.mapbox.mapboxsdk.location.engine.LocationEngineResult

public final class LocationEngineResult
extends java.lang.Object

A wrapper class representing location result from the location engine.

TODO: Override default equals(), hashCode() and toString()

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static LocationEngineResult	create(java.util.List<android.location.Location> locations) Creates LocationEngineResult instance for given list of locations.
static LocationEngineResult	create(android.location.Location location) Creates LocationEngineResult instance for location.
static LocationEngineResult	extractResult(android.content.Intent intent) Extracts location result from intent object
android.location.Location	getLastLocation() Returns most recent location available in this result.
java.util.List<android.location.Location>	getLocations() Returns locations computed, ordered from oldest to newest.

Methods inherited from class java.lang.Object

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

Method Detail

create

@NonNull
public static LocationEngineResult create(@Nullable
                                                   android.location.Location location)

Creates LocationEngineResult instance for location.

Parameters:

location - default location added to the result.

Returns:

instance of the new location result.

Since:

1.0.0

create

@NonNull
public static LocationEngineResult create(@Nullable
                                                   java.util.List<android.location.Location> locations)

Creates LocationEngineResult instance for given list of locations.

Parameters:

locations - list of locations.

Returns:

instance of the new location result.

Since:

1.0.0

getLastLocation

@Nullable
public android.location.Location getLastLocation()

Returns most recent location available in this result.

Returns:

the most recent location Location or null.

Since:

1.0.0

getLocations

public java.util.List<android.location.Location> getLocations()

Returns locations computed, ordered from oldest to newest.

Returns:

ordered list of locations.

Since:

1.0.0

extractResult

@Nullable
public static LocationEngineResult extractResult(android.content.Intent intent)

Extracts location result from intent object

Parameters:

intent - valid intent object

Returns:

location result.

Since:

1.1.0