Package megamek.common.board

Record Class BoardIssue

java.lang.Object

java.lang.Record

megamek.common.board.BoardIssue

Record Components:

coords - the hex the issue is reported at

message - the description shown to the user

fix - a recommended way to fix it

public record BoardIssue(Coords coords, String message, String fix)
extends Record

A problem or note found on a board, together with the hex it concerns, so that a board editor can take the user to that hex.

Constructor Summary

Constructors

Constructor	Description
BoardIssue(Coords coords, String message, String fix)	Creates an instance of a BoardIssue record class.

Method Summary

Modifier and Type	Method	Description
Coords	coords()	Returns the value of the coords record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	fix()	Returns the value of the fix record component.
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message 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

BoardIssue

public BoardIssue(Coords coords,
 String message,
 String fix)

Creates an instance of a BoardIssue record class.

Parameters:

coords - the value for the coords record component

message - the value for the message record component

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

coords

public Coords coords()

Returns the value of the coords record component.

Returns:

the value of the coords record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

fix

public String fix()

Returns the value of the fix record component.

Returns:

the value of the fix record component