GPX.Builder (JPX 1.3.0)

java.lang.Object
- io.jenetics.jpx.GPX.Builder

Enclosing class:: GPX

public static final class GPX.Builder
extends Object

Builder class for creating immutable GPX objects.

Creating a GPX object with one track-segment and 3 track-points:


 final GPX gpx = GPX.builder()
     .addTrack(track -> track
         .addSegment(segment -> segment
             .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(160))
             .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(161))
             .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(162))))
     .build();

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GPX.Builder`	`addRoute(Consumer<Route.Builder> route)` Add a route the `GPX` object.
`GPX.Builder`	`addRoute(Route route)` Add a route the `GPX` object.
`GPX.Builder`	`addTrack(Consumer<Track.Builder> track)` Add a track the `GPX` object.
`GPX.Builder`	`addTrack(Track track)` Add a track the `GPX` object.
`GPX.Builder`	`addWayPoint(Consumer<WayPoint.Builder> wayPoint)` Add a way-point to the `GPX` object using a `WayPoint.Builder`.
`GPX.Builder`	`addWayPoint(WayPoint wayPoint)` Add one way-point to the `GPX` object.
`GPX`	`build()` Create an immutable `GPX` object from the current builder state.
`String`	`creator()` Return the current creator value.
`GPX.Builder`	`creator(String creator)` Set the GPX creator.
`Optional<Metadata>`	`metadata()` Return the current metadata value.
`GPX.Builder`	`metadata(Consumer<Metadata.Builder> metadata)` Allows to set partial metadata without messing up with the `Metadata.Builder` class.
`GPX.Builder`	`metadata(Metadata metadata)` Set the GPX metadata.
`Filter<Route,GPX.Builder>`	`routeFilter()` Return a new `Route` filter.
`List<Route>`	`routes()` Return the current routes.
`GPX.Builder`	`routes(List<Route> routes)` Sets the routes of the `GPX` object.
`Filter<Track,GPX.Builder>`	`trackFilter()` Return a new `Track` filter.
`List<Track>`	`tracks()` Return the current tracks.
`GPX.Builder`	`tracks(List<Track> tracks)` Sets the tracks of the `GPX` object.
`String`	`version()` Return the current version value.
`GPX.Builder`	`version(GPX.Version version)` Set the GPX version.
`Filter<WayPoint,GPX.Builder>`	`wayPointFilter()` Return a new `WayPoint` filter.
`List<WayPoint>`	`wayPoints()` Return the current way-points.
`GPX.Builder`	`wayPoints(List<WayPoint> wayPoints)` Sets the way-points of the `GPX` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - creator
```
public GPX.Builder creator(String creator)
```
    Set the GPX creator.
    
    Parameters:
    
    creator - the GPX creator
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given argument is null
  - creator
```
public String creator()
```
    Return the current creator value.
    
    Returns:
    
    the current creator value
    
    Since:
    
    1.1
  - version
```
public GPX.Builder version(GPX.Version version)
```
    Set the GPX version.
    
    Parameters:
    
    version - the GPX version
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given argument is null
    
    Since:
    
    1.3
  - version
```
public String version()
```
    Return the current version value.
    
    Returns:
    
    the current version value
    
    Since:
    
    1.1
  - metadata
```
public GPX.Builder metadata(Metadata metadata)
```
    Set the GPX metadata.
    
    Parameters:
    
    metadata - the GPX metadata
    
    Returns:
    
    this Builder for method chaining
  - metadata
```
public GPX.Builder metadata(Consumer<Metadata.Builder> metadata)
```
    Allows to set partial metadata without messing up with the Metadata.Builder class.
```
 final GPX gpx = GPX.builder()
     .metadata(md -> md.author("Franz Wilhelmstötter"))
     .addTrack(...)
     .build();
 
```
    Parameters:
    
    metadata - the metadata consumer
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given argument is null
  - metadata
```
public Optional<Metadata> metadata()
```
    Return the current metadata value.
    
    Returns:
    
    the current metadata value
    
    Since:
    
    1.1
  - wayPoints
```
public GPX.Builder wayPoints(List<WayPoint> wayPoints)
```
    Sets the way-points of the GPX object. The list of way-points may be null.
    
    Parameters:
    
    wayPoints - the GPX way-points
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if one of the way-points in the list is null
  - addWayPoint
```
public GPX.Builder addWayPoint(WayPoint wayPoint)
```
    Add one way-point to the GPX object.
    
    Parameters:
    
    wayPoint - the way-point to add
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given wayPoint is null
  - addWayPoint
```
public GPX.Builder addWayPoint(Consumer<WayPoint.Builder> wayPoint)
```
    Add a way-point to the GPX object using a WayPoint.Builder.
```
 final GPX gpx = GPX.builder()
     .addWayPoint(wp -> wp.lat(23.6).lon(13.5).ele(50))
     .build();
 
```
    Parameters:
    
    wayPoint - the way-point to add, configured by the way-point builder
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given argument is null
  - wayPoints
```
public List<WayPoint> wayPoints()
```
    Return the current way-points. The returned list is mutable.
    
    Returns:
    
    the current, mutable way-point list
    
    Since:
    
    1.1
  - routes
```
public GPX.Builder routes(List<Route> routes)
```
    Sets the routes of the GPX object. The list of routes may be null.
    
    Parameters:
    
    routes - the GPX routes
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if one of the routes is null
  - addRoute
```
public GPX.Builder addRoute(Route route)
```
    Add a route the GPX object.
    
    Parameters:
    
    route - the route to add
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given route is null
  - addRoute
```
public GPX.Builder addRoute(Consumer<Route.Builder> route)
```
    Add a route the GPX object.
```
 final GPX gpx = GPX.builder()
     .addRoute(route -> route
         .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(160))
         .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(161)))
     .build();
 
```
    Parameters:
    
    route - the route to add, configured by the route builder
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given argument is null
  - routes
```
public List<Route> routes()
```
    Return the current routes. The returned list is mutable.
    
    Returns:
    
    the current, mutable route list
    
    Since:
    
    1.1
  - tracks
```
public GPX.Builder tracks(List<Track> tracks)
```
    Sets the tracks of the GPX object. The list of tracks may be null.
    
    Parameters:
    
    tracks - the GPX tracks
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if one of the tracks is null
  - addTrack
```
public GPX.Builder addTrack(Track track)
```
    Add a track the GPX object.
    
    Parameters:
    
    track - the track to add
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given track is null
  - addTrack
```
public GPX.Builder addTrack(Consumer<Track.Builder> track)
```
    Add a track the GPX object.
```
 final GPX gpx = GPX.builder()
     .addTrack(track -> track
         .addSegment(segment -> segment
             .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(160))
             .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(161))
             .addPoint(p -> p.lat(48.2081743).lon(16.3738189).ele(162))))
     .build();
 
```
    Parameters:
    
    track - the track to add, configured by the track builder
    
    Returns:
    
    this Builder for method chaining
    
    Throws:
    
    NullPointerException - if the given argument is null
  - tracks
```
public List<Track> tracks()
```
    Return the current tracks. The returned list is mutable.
    
    Returns:
    
    the current, mutable track list
    
    Since:
    
    1.1
  - build
```
public GPX build()
```
    Create an immutable GPX object from the current builder state.
    
    Returns:
    
    an immutable GPX object from the current builder state
  - wayPointFilter
```
public Filter<WayPoint,GPX.Builder> wayPointFilter()
```
    Return a new WayPoint filter.
```
 final GPX filtered = gpx.toBuilder()
     .wayPointFilter()
         .filter(wp -> wp.getTime().isPresent())
         .build())
     .build();
 
```
    Returns:
    
    a new WayPoint filter
    
    Since:
    
    1.1
  - routeFilter
```
public Filter<Route,GPX.Builder> routeFilter()
```
    Return a new Route filter.
```
 final GPX filtered = gpx.toBuilder()
     .routeFilter()
         .filter(Route::nonEmpty)
         .build())
     .build();
 
```
    Returns:
    
    a new Route filter
    
    Since:
    
    1.1
  - trackFilter
```
public Filter<Track,GPX.Builder> trackFilter()
```
    Return a new Track filter.
```
 final GPX merged = gpx.toBuilder()
     .trackFilter()
         .map(track -> track.toBuilder()
             .listMap(Filters::mergeSegments)
             .filter(TrackSegment::nonEmpty)
             .build())
         .build()
     .build();
 
```
    Returns:
    
    a new Track filter
    
    Since:
    
    1.1

Class GPX.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

creator

creator

version

version

metadata

metadata

metadata

wayPoints

addWayPoint

addWayPoint

wayPoints

routes

addRoute

addRoute

routes

tracks

addTrack

addTrack

tracks

build

wayPointFilter

routeFilter

trackFilter