Package com.cta4j.train.station.model

Record Class Location

java.lang.Object

java.lang.Record

com.cta4j.train.station.model.Location

Record Components:

latitude - the latitude

longitude - the longitude

humanAddress - the human-readable address, or null if not available

@NullMarked
public record Location(BigDecimal latitude, BigDecimal longitude, @Nullable HumanAddress humanAddress)
extends Record

Represents a geographical location with latitude and longitude, optionally including a human-readable address.

Constructor Summary

Constructors

Constructor	Description
Location(BigDecimal latitude, BigDecimal longitude, @Nullable HumanAddress humanAddress)	Constructs a Location.

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.
@Nullable HumanAddress	humanAddress()	Returns the value of the humanAddress 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 java.lang.Object

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

Constructor Details

Location

public Location(BigDecimal latitude,
 BigDecimal longitude,
 @Nullable HumanAddress humanAddress)

Constructs a Location.

Parameters:

latitude - the latitude

longitude - the longitude

humanAddress - the human-readable address, or null if not available

Throws:

NullPointerException - if latitude or longitude is null

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.

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

humanAddress

public @Nullable HumanAddress humanAddress()

Returns the value of the humanAddress record component.

Returns:

the value of the humanAddress record component