Package com.cta4j.bus.prediction.query

Class StopsPredictionsQuery.Builder

java.lang.Object

com.cta4j.bus.prediction.query.StopsPredictionsQuery.Builder

Enclosing class:

StopsPredictionsQuery

public static final class StopsPredictionsQuery.Builder
extends Object

A builder for StopsPredictionsQuery.

Constructor Summary

Constructors

Constructor	Description
Builder(List<String> stopIds)	Constructs a Builder.

Method Summary

Modifier and Type	Method	Description
StopsPredictionsQuery	build()	Builds the StopsPredictionsQuery.
StopsPredictionsQuery.Builder	maxResults(Integer maxResults)	Sets the maximum number of predictions to return.
StopsPredictionsQuery.Builder	routeIds(List<String> routeIds)	Sets the List of route IDs to filter predictions by.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(List<String> stopIds)

Constructs a Builder.

Parameters:

stopIds - the List of stop IDs to retrieve predictions for

Throws:

NullPointerException - if stopIds or any of its elements are null

Method Details

routeIds

public StopsPredictionsQuery.Builder routeIds(List<String> routeIds)

Sets the List of route IDs to filter predictions by.

Parameters:

routeIds - the List of route IDs

Returns:

this Builder instance

Throws:

NullPointerException - if routeIds or any of its elements are null

maxResults

public StopsPredictionsQuery.Builder maxResults(Integer maxResults)

Sets the maximum number of predictions to return.

Parameters:

maxResults - the maximum number of predictions

Returns:

this Builder instance

Throws:

NullPointerException - if maxResults is null

IllegalArgumentException - if maxResults is not positive

build

public StopsPredictionsQuery build()

Builds the StopsPredictionsQuery.

Returns:

a new StopsPredictionsQuery instance