Package io.jmix.dynmodelai.modelchange

Record Class MutationResult

java.lang.Object

java.lang.Record

io.jmix.dynmodelai.modelchange.MutationResult

public record MutationResult(@Nullable DynamicModelDefinition definition, @Nullable String message, List<MutationIssue> issues)
extends Record

A prepared candidate definition or the issues that prevented its creation. Success means operation preconditions passed; migration validation is still required before use.

Constructor Summary

Constructors

Constructor	Description
MutationResult(@Nullable DynamicModelDefinition definition, @Nullable String message, List<MutationIssue> issues)	Creates an instance of a MutationResult record class.

Method Summary

Modifier and Type	Method	Description
@Nullable DynamicModelDefinition	definition()	Returns the value of the definition record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static MutationResult	failed(MutationIssue issue)
static MutationResult	failed(List<MutationIssue> issues)
final int	hashCode()	Returns a hash code value for this object.
List<MutationIssue>	issues()	Returns the value of the issues record component.
@Nullable String	message()	Returns the value of the message record component.
boolean	ok()
static MutationResult	ok(DynamicModelDefinition definition, String message)
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

MutationResult

public MutationResult(@Nullable DynamicModelDefinition definition,
 @Nullable String message,
 List<MutationIssue> issues)

Creates an instance of a MutationResult record class.

Parameters:

definition - the value for the definition record component

message - the value for the message record component

issues - the value for the issues record component

Method Details

ok

public boolean ok()

ok

public static MutationResult ok(DynamicModelDefinition definition,
 String message)

failed

public static MutationResult failed(List<MutationIssue> issues)

failed

public static MutationResult failed(MutationIssue issue)

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.

definition

public @Nullable DynamicModelDefinition definition()

Returns the value of the definition record component.

Returns:

the value of the definition record component

message

public @Nullable String message()

Returns the value of the message record component.

Returns:

the value of the message record component

issues

public List<MutationIssue> issues()

Returns the value of the issues record component.

Returns:

the value of the issues record component