Package com.cta4j.train.arrival.query

Class StopArrivalQuery.Builder

java.lang.Object

com.cta4j.train.arrival.query.StopArrivalQuery.Builder

Enclosing class:

StopArrivalQuery

public static final class StopArrivalQuery.Builder
extends Object

A builder for StopArrivalQuery.

Constructor Summary

Constructors

Constructor	Description
Builder(String stopId)	Constructs a Builder.

Method Summary

Modifier and Type	Method	Description
StopArrivalQuery	build()	Builds the StopArrivalQuery.
StopArrivalQuery.Builder	line(TrainLine line)	Sets the train line to filter arrival information by.
StopArrivalQuery.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 stopId)

Constructs a Builder.

Parameters:

stopId - the ID of the stop to retrieve arrival information for

Throws:

NullPointerException - if stopId is null

Method Details

line

public StopArrivalQuery.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 StopArrivalQuery.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 StopArrivalQuery build()

Builds the StopArrivalQuery.

Returns:

a new StopArrivalQuery instance