Package slash.navigation.routing

Record Class RoutingResult

java.lang.Object

java.lang.Record

slash.navigation.routing.RoutingResult

public record RoutingResult(List<NavigationPosition> positions, DistanceAndTime distanceAndTime, RoutingResult.Validity validity)
extends Record

The result for the routing between two positions.

Author:

Christian Pesch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RoutingResult.Validity

Constructor Summary

Constructors

Constructor	Description
RoutingResult(List<NavigationPosition> positions, DistanceAndTime distanceAndTime, RoutingResult.Validity validity)	Creates an instance of a RoutingResult record class.

Method Summary

Modifier and Type	Method	Description
DistanceAndTime	distanceAndTime()	Returns the value of the distanceAndTime 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.
List<NavigationPosition>	positions()	Returns the value of the positions record component.
final String	toString()	Returns a string representation of this record class.
RoutingResult.Validity	validity()	Returns the value of the validity record component.

Methods inherited from class java.lang.Object

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

Constructor Details

RoutingResult

public RoutingResult(List<NavigationPosition> positions,
 DistanceAndTime distanceAndTime,
 RoutingResult.Validity validity)

Creates an instance of a RoutingResult record class.

Parameters:

positions - the value for the positions record component

distanceAndTime - the value for the distanceAndTime record component

validity - the value for the validity 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.

positions

public List<NavigationPosition> positions()

Returns the value of the positions record component.

Returns:

the value of the positions record component

distanceAndTime

public DistanceAndTime distanceAndTime()

Returns the value of the distanceAndTime record component.

Returns:

the value of the distanceAndTime record component

validity

public RoutingResult.Validity validity()

Returns the value of the validity record component.

Returns:

the value of the validity record component