Package com.cta4j.train.arrival.query

Class MapArrivalQuery.Builder

java.lang.Object

com.cta4j.train.arrival.query.MapArrivalQuery.Builder

Enclosing class:

MapArrivalQuery

public static final class MapArrivalQuery.Builder
extends Object

A builder for MapArrivalQuery.

Constructor Summary

Constructors

Constructor	Description
Builder(String mapId)	Constructs a Builder.

Method Summary

Modifier and Type	Method	Description
MapArrivalQuery	build()	Builds the MapArrivalQuery.
MapArrivalQuery.Builder	line(TrainLine line)	Sets the train line to filter arrival information by.
MapArrivalQuery.Builder	maxResults(Integer maxResults)	Sets the maximum number of arrival information to return.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String mapId)

Constructs a Builder.

Parameters:

mapId - the ID of the map to retrieve arrival information for

Throws:

NullPointerException - if mapId is null

Method Details

line

public MapArrivalQuery.Builder line(TrainLine line)

Sets the train line to filter arrival information by.

Parameters:

line - the train line

Returns:

this Builder instance

Throws:

NullPointerException - if line is null

maxResults

public MapArrivalQuery.Builder maxResults(Integer maxResults)

Sets the maximum number of arrival information to return.

Parameters:

maxResults - the maximum number of arrival information

Returns:

this Builder instance

Throws:

NullPointerException - if maxResults is null

IllegalArgumentException - if maxResults is not positive

build

public MapArrivalQuery build()

Builds the MapArrivalQuery.

Returns:

a new MapArrivalQuery instance