Module cta4j.java.sdk

Package com.cta4j.train.model

Record Class Train

java.lang.Object

java.lang.Record

com.cta4j.train.model.Train

Record Components:

coordinates - the coordinates and heading of the train

arrivals - the list of upcoming train arrivals for the train

public record Train(TrainCoordinates coordinates, List<UpcomingTrainArrival> arrivals)
extends Record

A train currently in service.

Constructor Summary

Constructors

Constructor	Description
Train(TrainCoordinates coordinates, List<UpcomingTrainArrival> arrivals)	Creates an instance of a Train record class.

Method Summary

Modifier and Type	Method	Description
List<UpcomingTrainArrival>	arrivals()	Returns the value of the arrivals record component.
TrainCoordinates	coordinates()	Returns the value of the coordinates record component.
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.
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

Train

public Train(TrainCoordinates coordinates,
 List<UpcomingTrainArrival> arrivals)

Creates an instance of a Train record class.

Parameters:

coordinates - the value for the coordinates record component

arrivals - the value for the arrivals record component

Method Details

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.

coordinates

public TrainCoordinates coordinates()

Returns the value of the coordinates record component.

Returns:

the value of the coordinates record component

arrivals

public List<UpcomingTrainArrival> arrivals()

Returns the value of the arrivals record component.

Returns:

the value of the arrivals record component