Package com.cta4j.bus.prediction.query

Record Class StopsPredictionsQuery

java.lang.Object

java.lang.Record

com.cta4j.bus.prediction.query.StopsPredictionsQuery

Record Components:

stopIds - the List of stop IDs to retrieve predictions for

routeIds - the optional List of route IDs to filter predictions by

maxResults - the optional maximum number of predictions to return

@NullMarked
public record StopsPredictionsQuery(List<String> stopIds, @Nullable List<String> routeIds, @Nullable Integer maxResults)
extends Record

Represents a query for bus arrival predictions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StopsPredictionsQuery.Builder	A builder for StopsPredictionsQuery.

Constructor Summary

Constructors

Constructor	Description
StopsPredictionsQuery(List<String> stopIds, @Nullable List<String> routeIds, @Nullable Integer maxResults)	Constructs a StopsPredictionsQuery.

Method Summary

Modifier and Type	Method	Description
static StopsPredictionsQuery.Builder	builder(List<String> stopIds)	Creates a builder for StopsPredictionsQuery.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Integer	maxResults()	Returns the value of the maxResults record component.
@Nullable List<String>	routeIds()	Returns the value of the routeIds record component.
List<String>	stopIds()	Returns the value of the stopIds record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

StopsPredictionsQuery

public StopsPredictionsQuery(List<String> stopIds,
 @Nullable List<String> routeIds,
 @Nullable Integer maxResults)

Constructs a StopsPredictionsQuery.

Parameters:

stopIds - the List of stop IDs to retrieve predictions for

routeIds - the optional List of route IDs to filter predictions by

maxResults - the optional maximum number of predictions to return

Throws:

NullPointerException - if stopIds or any of its elements are null, or if any element of routeIds is null

IllegalArgumentException - if maxResults is non-null and not positive

Method Details

builder

public static StopsPredictionsQuery.Builder builder(List<String> stopIds)

Creates a builder for StopsPredictionsQuery.

Parameters:

stopIds - the List of stop IDs to retrieve predictions for

Returns:

a new Builder instance

Throws:

NullPointerException - if stopIds or any of its elements are null

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

stopIds

public List<String> stopIds()

Returns the value of the stopIds record component.

Returns:

the value of the stopIds record component

routeIds

public @Nullable List<String> routeIds()

Returns the value of the routeIds record component.

Returns:

the value of the routeIds record component

maxResults

public @Nullable Integer maxResults()

Returns the value of the maxResults record component.

Returns:

the value of the maxResults record component