Package es.situm.sdk.model.location

Class Location.Builder

java.lang.Object

es.situm.sdk.model.location.Location.Builder

Enclosing class:

Location

public static final class Location.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(long timestamp, String provider, Point position, float accuracy)
Builder(Location copy)

Method Summary

Modifier and Type	Method	Description
Location.Builder	bearing(Angle bearing)	Used in outdoor locations.
Location	build()
Location.Builder	cartesianBearing(Angle cartesianBearing, Angle bearing)	Used in indoor locations.
Location.Builder	cartesianBearing(Angle cartesianBearing, Angle bearing, Location.Quality cartesianBearingQuality)
Location.Builder	customFields(Map<String,String> customFields)
Location.Builder	deviceId(String deviceId)	Identifier of the device that has generated the location (Retrieve the identifier of the device by using SitumSDK#getDeviceID()
Location.Builder	position(Point point)
Location.Builder	quality(Location.Quality quality)
Location.Builder	timestamp(long timestamp)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(long timestamp,
               @NonNull
               String provider,
               @NonNull
               Point position,
               float accuracy)

Builder

public Builder(@NonNull
               Location copy)

Method Detail

timestamp

@NonNull
public Location.Builder timestamp(long timestamp)

quality

@NonNull
public Location.Builder quality(Location.Quality quality)

cartesianBearing

@NonNull
public Location.Builder cartesianBearing(Angle cartesianBearing,
                                         Angle bearing)

Used in indoor locations. The bearing quality assumed will be Location.Quality.HIGH

cartesianBearing

@NonNull
public Location.Builder cartesianBearing(Angle cartesianBearing,
                                         Angle bearing,
                                         Location.Quality cartesianBearingQuality)

bearing

@NonNull
public Location.Builder bearing(Angle bearing)

Used in outdoor locations. The bearing quality assumed will be Location.Quality.HIGH

deviceId

@NonNull
public Location.Builder deviceId(String deviceId)

Identifier of the device that has generated the location (Retrieve the identifier of the device by using SitumSDK#getDeviceID()

Parameters:

deviceId - unique identifier of the devide

Returns:

Location Builder

position

@NonNull
public Location.Builder position(Point point)

customFields

@NonNull
public Location.Builder customFields(Map<String,String> customFields)

build

@NonNull
public Location build()