Package mekhq.campaign

Record Class RouteAlternativesPlanner.Course

java.lang.Object

java.lang.Record

mekhq.campaign.RouteAlternativesPlanner.Course

Enclosing class:

RouteAlternativesPlanner

public static record RouteAlternativesPlanner.Course(RouteAlternativesPlanner.CourseKind kind, List<PlanetarySystem> systems, double oneGTotalDays, RouteAlternativesPlanner.CircuitCoverage circuitCoverage)
extends Record

One immutable route comparison.

Constructor Summary

Constructors

Constructor	Description
Course(RouteAlternativesPlanner.CourseKind kind, List<PlanetarySystem> systems, double oneGTotalDays, RouteAlternativesPlanner.CircuitCoverage circuitCoverage)	Creates an instance of a Course record class.

Method Summary

Modifier and Type	Method	Description
RouteAlternativesPlanner.CircuitCoverage	circuitCoverage()	Returns the value of the circuitCoverage 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.
int	jumps()
RouteAlternativesPlanner.CourseKind	kind()	Returns the value of the kind record component.
double	oneGTotalDays()	Returns the value of the oneGTotalDays record component.
List<PlanetarySystem>	systems()	Returns the value of the systems record component.
JumpPath	toJumpPath()
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

Course

public Course(RouteAlternativesPlanner.CourseKind kind,
 List<PlanetarySystem> systems,
 double oneGTotalDays,
 RouteAlternativesPlanner.CircuitCoverage circuitCoverage)

Creates an instance of a Course record class.

Parameters:

kind - the value for the kind record component

systems - the value for the systems record component

oneGTotalDays - the value for the oneGTotalDays record component

circuitCoverage - the value for the circuitCoverage record component

Method Details

jumps

public int jumps()

toJumpPath

public JumpPath toJumpPath()

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 '=='.

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.

kind

public RouteAlternativesPlanner.CourseKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

systems

public List<PlanetarySystem> systems()

Returns the value of the systems record component.

Returns:

the value of the systems record component

oneGTotalDays

public double oneGTotalDays()

Returns the value of the oneGTotalDays record component.

Returns:

the value of the oneGTotalDays record component

circuitCoverage

public RouteAlternativesPlanner.CircuitCoverage circuitCoverage()

Returns the value of the circuitCoverage record component.

Returns:

the value of the circuitCoverage record component