universum.studios.android.intent

Class MapIntent

java.lang.Object

universum.studios.android.intent.BaseIntent<MapIntent>

universum.studios.android.intent.MapIntent

public class MapIntent
extends BaseIntent<MapIntent>

A BaseIntent builder implementation providing API for building and starting of intents targeting a maps related applications.

Location via latitude + longitude

Simple intent to show map at a specific location can be created by specifying just latitude and longitude via location(double, double). You can also specify either label for the requested location via label(String) or zoom level via zoomLevel(int).

Location via query

In case when you want to show map at a specific location, but you do not know its exact location (lat + lng), you can specify location query via locationQuery(String), which can contain name of place (town/city) and state that you want to show on map. In this case you can also specify the location label via label(String) as for lat + lng based map intent.

Since:

1.0

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
static double	LAT_MAX Maximum allowed value for latitude.
static double	LAT_MIN Minimum allowed value for latitude.
static double	LNG_MAX Maximum allowed value for longitude.
static double	LNG_MIN Minimum allowed value for longitude.
static String	URI_SCHEME Uri scheme for map targeting intents.
static int	ZOOM_LEVEL_MAX Maximum allowed value for zoom level.
static int	ZOOM_LEVEL_MIN Minimum allowed value for zoom level.

Constructor Summary

Constructors

Constructor and Description
MapIntent()

Method Summary

Modifier and Type	Method and Description
protected void	ensureCanBuildOrThrow() Called to ensure that this builder can build its Intent from its current data.
String	label() Returns the label text for the requested map location.
MapIntent	label(String label) Sets a text by which should be labeled the requested location on map.
double	lat() Returns the latitude position of a location to show on map.
double	lng() Returns the longitude position of a location to show on map.
MapIntent	location(double lat, double lng) Sets latitude and longitude of a location to show on a map.
String	locationQuery() Returns the location query targeting a specific location on a map.
MapIntent	locationQuery(String query) Sets a location query that will be used to target a desired location on a map.
protected Intent	onBuild(Context context) Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.
int	zoomLevel() Returns the zoom level at which will be map displayed.
MapIntent	zoomLevel(int level) Sets a zoom level at which should be a desired location on a map displayed to a user.

Methods inherited from class universum.studios.android.intent.BaseIntent

activityNotFoundMessage, activityNotFoundMessage, build, cannotBuildIntentException, dialogTitle, dialogTitle, enterTransition, enterTransition, exitTransition, exitTransition, isActivityForIntentAvailable, notifyActivityNotFound, onStartWith, startWith, transitions

Methods inherited from class java.lang.Object

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

Field Detail

URI_SCHEME

public static final String URI_SCHEME

Uri scheme for map targeting intents.

Constant value: geo

See Also:

Constant Field Values

LAT_MIN

public static final double LAT_MIN

Minimum allowed value for latitude.

See Also:

Constant Field Values

LAT_MAX

public static final double LAT_MAX

Maximum allowed value for latitude.

See Also:

Constant Field Values

LNG_MIN

public static final double LNG_MIN

Minimum allowed value for longitude.

See Also:

Constant Field Values

LNG_MAX

public static final double LNG_MAX

Maximum allowed value for longitude.

See Also:

Constant Field Values

ZOOM_LEVEL_MIN

public static final int ZOOM_LEVEL_MIN

Minimum allowed value for zoom level.

See Also:

Constant Field Values

ZOOM_LEVEL_MAX

public static final int ZOOM_LEVEL_MAX

Maximum allowed value for zoom level.

See Also:

Constant Field Values

Constructor Detail

MapIntent

public MapIntent()

Method Detail

location

public MapIntent location(double lat,
                          double lng)

Sets latitude and longitude of a location to show on a map.

Parameters:

lat - The desired location's latitude position in the range [-90, 90].

lng - The desired location's longitude position in the range [-180, 180].

Returns:

This intent builder to allow methods chaining.

See Also:

lat(), lng()

lat

public double lat()

Returns the latitude position of a location to show on map.

Returns:

Latitude position on a map from the range [-90, 90], 0 by default.

See Also:

location(double, double), lng()

lng

public double lng()

Returns the longitude position of a location to show on map.

Returns:

Longitude position on a map from the range [-180, 180], 0 by default.

See Also:

location(double, double), lat()

locationQuery

public MapIntent locationQuery(@Nullable
                               String query)

Sets a location query that will be used to target a desired location on a map.

Parameters:

query - The desired location query. Can be for example name of a desired town with street address and address number to show on a map.

Returns:

This intent builder to allow methods chaining.

See Also:

locationQuery()

locationQuery

@NonNull
public String locationQuery()

Returns the location query targeting a specific location on a map.

Returns:

Location query or empty string in not specified yet.

See Also:

locationQuery(String)

zoomLevel

public MapIntent zoomLevel(int level)

Sets a zoom level at which should be a desired location on a map displayed to a user.

Parameters:

level - The desired zoom level in the range [1, 23]. The highest level, the closest to map.

Returns:

This intent builder to allow methods chaining.

See Also:

zoomLevel()

zoomLevel

public int zoomLevel()

Returns the zoom level at which will be map displayed.

Returns:

Zoom level from the range [1, 23] or 0 by default.

See Also:

zoomLevel(int)

label

public MapIntent label(@Nullable
                       String label)

Sets a text by which should be labeled the requested location on map.

Parameters:

label - The desired label text.

Returns:

This intent builder to allow methods chaining.

See Also:

label()

label

@NonNull
public String label()

Returns the label text for the requested map location.

Returns:

Label text.

See Also:

label(String)

ensureCanBuildOrThrow

protected void ensureCanBuildOrThrow()

Description copied from class: BaseIntent

Called to ensure that this builder can build its Intent from its current data.

If there are some required data missing/not specified, an exception indicating such state should be thrown. The default exception may be created via BaseIntent.cannotBuildIntentException(String).

Overrides:

ensureCanBuildOrThrow in class BaseIntent<MapIntent>

onBuild

@NonNull
protected Intent onBuild(@NonNull
                                  Context context)

Description copied from class: BaseIntent

Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.

Specified by:

onBuild in class BaseIntent<MapIntent>

Parameters:

context - Context obtained from the IntentStarter.

Returns:

Intent instance with current data.