com.tomtom.speedtools.gpstrace

Class GpsTrace

java.lang.Object

com.tomtom.speedtools.gpstrace.GpsTrace

All Implemented Interfaces:

JsonRenderable

public final class GpsTrace
extends Object
implements JsonRenderable

This class represents a trace of GPS points. Constructor: GpsTrace()

Constructor Summary

Constructors

Constructor and Description
GpsTrace() Same as GpsTrace(), for an empty list.
GpsTrace(Collection<GpsTracePoint> gpsTracePoints) Create a GPS trace.

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(Object obj)
boolean	equals(Object obj)
List<GpsTracePoint>	getGpsTracePoints() Retrieve trace data.
GpsTracePoint	getLastGpsTracePoint() Get latest, most recent GPS point.
int	hashCode()
static Collection<GpsTracePoint>	limitSize(org.joda.time.Duration maxAge, Integer maxSize, Collection<GpsTracePoint> gpsTracePoints1, GpsTracePoint... gpsTracePoints2) Return a limited list of GPS points.
String	toJson() Provide a Json representation of a domain object.
String	toString()
GpsTrace	withGpsTracePoints(Collection<GpsTracePoint> gpsTracePoints1, GpsTracePoint... gpsTracePoints2) Setter for getGpsTracePoints()
GpsTrace	withGpsTracePoints(GpsTracePoint... gpsTracePoints)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GpsTrace

public GpsTrace(@Nonnull
                Collection<GpsTracePoint> gpsTracePoints)

Create a GPS trace.

Parameters:

gpsTracePoints - Trace points.

GpsTrace

public GpsTrace()

Same as GpsTrace(), for an empty list.

Method Detail

getGpsTracePoints

@Nonnull
public List<GpsTracePoint> getGpsTracePoints()

Retrieve trace data.

Returns:

List of trace data points.

withGpsTracePoints

@Nonnull
public GpsTrace withGpsTracePoints(@Nonnull
                                            Collection<GpsTracePoint> gpsTracePoints1,
                                            @Nonnull
                                            GpsTracePoint... gpsTracePoints2)

Setter for getGpsTracePoints()

Parameters:

gpsTracePoints1 - New trace data.

gpsTracePoints2 - New trace data.

Returns:

New immutable object.

withGpsTracePoints

@Nonnull
public GpsTrace withGpsTracePoints(@Nonnull
                                            GpsTracePoint... gpsTracePoints)

getLastGpsTracePoint

@Nullable
public GpsTracePoint getLastGpsTracePoint()

Get latest, most recent GPS point.

Returns:

Latest, most recent GPS point, or null, if none available.

limitSize

@Nonnull
public static Collection<GpsTracePoint> limitSize(@Nonnull
                                                           org.joda.time.Duration maxAge,
                                                           @Nonnull
                                                           Integer maxSize,
                                                           @Nonnull
                                                           Collection<GpsTracePoint> gpsTracePoints1,
                                                           @Nonnull
                                                           GpsTracePoint... gpsTracePoints2)

Return a limited list of GPS points.

Parameters:

maxAge - Maximum age difference between oldest and newest point.

maxSize - Maximum number of points.

gpsTracePoints1 - Original list 1.

gpsTracePoints2 - Original list 2.

Returns:

Limited list.

canEqual

public boolean canEqual(@Nonnull
                        Object obj)

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toJson

public String toJson()

Description copied from interface: JsonRenderable

Provide a Json representation of a domain object. Typical implementations look like this: public String toJson() { return Json.toJson(this); } public String toString() { return Json.toStringJson(this); }

Specified by:

toJson in interface JsonRenderable

Returns:

Json representation of the object.

toString

public String toString()

Overrides:

toString in class Object