Record Class InspectionResult

java.lang.Object

java.lang.Record

io.hymods.lib.data.InspectionResult

public record InspectionResult(InspectionTargetType targetType, String displayName, @NullableDecl String targetId, boolean showIcon, List<InspectionLine> lines)
extends Record

A normalized inspection payload suitable for rendering into a HUD.

Constructor Summary

Constructors

Constructor	Description
InspectionResult(InspectionTargetType targetType, String displayName, String targetId, boolean showIcon, List<InspectionLine> lines)	Creates an instance of a InspectionResult record class.

Method Summary

Modifier and Type	Method	Description
String	displayName()	Returns the value of the displayName 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.
boolean	hasTarget()
List<InspectionLine>	lines()	Returns the value of the lines record component.
static InspectionResult	none()
boolean	showIcon()	Returns the value of the showIcon record component.
String	targetId()	Returns the value of the targetId record component.
InspectionTargetType	targetType()	Returns the value of the targetType 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

InspectionResult

public InspectionResult(InspectionTargetType targetType,
 String displayName,
 @NullableDecl
 String targetId,
 boolean showIcon,
 List<InspectionLine> lines)

Creates an instance of a InspectionResult record class.

Parameters:

targetType - the value for the targetType record component

displayName - the value for the displayName record component

targetId - the value for the targetId record component

showIcon - the value for the showIcon record component

lines - the value for the lines record component

Method Details

hasTarget

public boolean hasTarget()

none

public static InspectionResult none()

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.

targetType

public InspectionTargetType targetType()

Returns the value of the targetType record component.

Returns:

the value of the targetType record component

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

targetId

@NullableDecl
public String targetId()

Returns the value of the targetId record component.

Returns:

the value of the targetId record component

showIcon

public boolean showIcon()

Returns the value of the showIcon record component.

Returns:

the value of the showIcon record component

lines

public List<InspectionLine> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component