Record Class MachineEvents.Action

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.machine.MachineEvents.Action

Record Components:

action - the action's id in the machine's type

Enclosing class:

MachineEvents

public static record MachineEvents.Action(@NotNull MachineInstance machine, @NotNull String action, MachineAction.Click click, MachineAction.Outcome outcome)
extends Record

Constructor Summary

Constructors

Constructor	Description
Action(@NotNull MachineInstance machine, @NotNull String action, MachineAction.Click click, MachineAction.Outcome outcome)	Creates an instance of a Action record class.

Method Summary

Modifier and Type	Method	Description
@NotNull String	action()	Returns the value of the action record component.
MachineAction.Click	click()	Returns the value of the click 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.
@NotNull MachineInstance	machine()	Returns the value of the machine record component.
MachineAction.Outcome	outcome()	Returns the value of the outcome 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

Action

public Action(@NotNull
 @NotNull MachineInstance machine,
 @NotNull
 @NotNull String action,
 @NotNull
 MachineAction.Click click,
 @NotNull
 MachineAction.Outcome outcome)

Creates an instance of a Action record class.

Parameters:

machine - the value for the machine record component

action - the value for the action record component

click - the value for the click record component

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

machine

@NotNull
public @NotNull MachineInstance machine()

Returns the value of the machine record component.

Returns:

the value of the machine record component

action

@NotNull
public @NotNull String action()

Returns the value of the action record component.

Returns:

the value of the action record component

click

@NotNull
public MachineAction.Click click()

Returns the value of the click record component.

Returns:

the value of the click record component

outcome

@NotNull
public MachineAction.Outcome outcome()

Returns the value of the outcome record component.

Returns:

the value of the outcome record component