Record Class TrainCoordinates

java.lang.Object

java.lang.Record

com.cta4j.model.train.TrainCoordinates

Record Components:

latitude - the latitude of the train's current location

longitude - the longitude of the train's current location

heading - the heading of the train in degrees (0-359)

public record TrainCoordinates(BigDecimal latitude, BigDecimal longitude, int heading)
extends Record

The coordinates and heading of a train.

Constructor Summary

Constructors

Constructor	Description
TrainCoordinates(BigDecimal latitude, BigDecimal longitude, int heading)	Creates an instance of a TrainCoordinates record class.

Method Summary

Modifier and Type	Method	Description
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.
int	heading()	Returns the value of the heading record component.
BigDecimal	latitude()	Returns the value of the latitude record component.
BigDecimal	longitude()	Returns the value of the longitude record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

TrainCoordinates

public TrainCoordinates(BigDecimal latitude,
 BigDecimal longitude,
 int heading)

Creates an instance of a TrainCoordinates record class.

Parameters:

latitude - the value for the latitude record component

longitude - the value for the longitude record component

heading - the value for the heading 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

latitude

public BigDecimal latitude()

Returns the value of the latitude record component.

Returns:

the value of the latitude record component

longitude

public BigDecimal longitude()

Returns the value of the longitude record component.

Returns:

the value of the longitude record component

heading

public int heading()

Returns the value of the heading record component.

Returns:

the value of the heading record component