Package com.axelor.workflow.compiler

Record Class Violation

java.lang.Object

java.lang.Record

com.axelor.workflow.compiler.Violation

public record Violation(String code, String message, String nodeId)
extends Record

One validation finding: a stable code (<element>-<attr>-<problem>), the translated message, and the nodeId it is about, or null for a workflow-level rule.

Constructor Summary

Constructors

Constructor	Description
Violation(String code, String message, String nodeId)	Creates an instance of a Violation record class.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the value of the code record component.
static String	describe(Workflow workflow, List<Violation> violations)	The same for a definition, named by its name, or its id when it has none.
String	describe(String workflow)	This finding as a person reads it: the workflow it is about, then what is wrong.
static String	describe(String workflow, List<Violation> violations)	Joins violations into the single message thrown at a save boundary, one per line.
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.
String	message()	Returns the value of the message record component.
String	nodeId()	Returns the value of the nodeId record component.
static Violation	of(String code, String nodeId, String message, Object... args)	A finding whose message the caller has already passed through I18n.get, so the extractor sees the literal; args fill its placeholders.
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

Violation

public Violation(String code,
 String message,
 String nodeId)

Creates an instance of a Violation record class.

Parameters:

code - the value for the code record component

message - the value for the message record component

nodeId - the value for the nodeId record component

Method Details

of

public static Violation of(String code,
 String nodeId,
 String message,
 Object... args)

A finding whose message the caller has already passed through I18n.get, so the extractor sees the literal; args fill its placeholders.

describe

public String describe(String workflow)

This finding as a person reads it: the workflow it is about, then what is wrong.

describe

public static String describe(Workflow workflow,
 List<Violation> violations)

The same for a definition, named by its name, or its id when it has none.

describe

public static String describe(String workflow,
 List<Violation> violations)

Joins violations into the single message thrown at a save boundary, one per line.

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.

code

public String code()

Returns the value of the code record component.

Returns:

the value of the code record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

nodeId

public String nodeId()

Returns the value of the nodeId record component.

Returns:

the value of the nodeId record component