Package de.xam.featdoc.system

Record Class TerminalEffect

java.lang.Object

java.lang.Record

de.xam.featdoc.system.TerminalEffect

All Implemented Interfaces:

CauseAndEffect, Effect

public record TerminalEffect(@Nullable Rule rule, Message message, @Nullable String comment, System system)
extends Record
implements Effect

Constructor Summary

Constructors

Constructor	Description
TerminalEffect(Rule rule, Message message, String comment, System system)	Creates an instance of a TerminalEffect record class.

Method Summary

Modifier and Type	Method	Description
String	comment()	Returns the value of the comment 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.
Message	message()	Returns the value of the message record component.
static TerminalEffect	of(Cause cause)
Rule	rule()	Returns the value of the rule record component.
System	system()	Returns the value of the system 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

Methods inherited from interface de.xam.featdoc.system.CauseAndEffect

hasComment

Methods inherited from interface de.xam.featdoc.system.Effect

asCause

Constructor Details

TerminalEffect

public TerminalEffect(@Nullable
 Rule rule,
 Message message,
 @Nullable
 String comment,
 System system)

Creates an instance of a TerminalEffect record class.

Parameters:

rule - the value for the rule record component

message - the value for the message record component

comment - the value for the comment record component

system - the value for the system record component

Method Details

of

public static TerminalEffect of(Cause cause)

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.

rule

@Nullable
public Rule rule()

Returns the value of the rule record component.

Specified by:

rule in interface CauseAndEffect

Returns:

the value of the rule record component

message

public Message message()

Returns the value of the message record component.

Specified by:

message in interface CauseAndEffect

Returns:

the value of the message record component

comment

@Nullable
public String comment()

Returns the value of the comment record component.

Specified by:

comment in interface CauseAndEffect

Returns:

the value of the comment record component

system

public System system()

Returns the value of the system record component.

Specified by:

system in interface CauseAndEffect

Returns:

the value of the system record component