Package dk.gtz.graphedit.model

Record Class ModelLint

java.lang.Object

java.lang.Record

dk.gtz.graphedit.model.ModelLint

Record Components:

modelKey - The key of the related model (see IBufferContainer)

lintIdentifier - Unique identifier for the type of lint

severity - The severity level of the lint

title - A very brief headline describing the lint

message - A detailed message displayed to the user

lintDescription - A general description of what this kind of lint represents

affectedElements - A list of which syntactic elements should be highlighted

affectedRegions - A list of regions in the graph that should be highlighted

public record ModelLint(String modelKey, String lintIdentifier, ModelLintSeverity severity, String title, String message, Optional<String> lintDescription, List<UUID> affectedElements, List<List<ModelPoint>> affectedRegions)
extends Record

Model object of a lint. A Lint is a special kind of diagnostic annotation that can provide smart meta-insights about sections of a graph.

Constructor Summary

Constructors

Constructor	Description
ModelLint(String modelKey, String lintIdentifier, ModelLintSeverity severity, String title, String message, Optional<String> lintDescription, List<UUID> affectedElements, List<List<ModelPoint>> affectedRegions)	Creates an instance of a ModelLint record class.

Method Summary

Modifier and Type	Method	Description
List<UUID>	affectedElements()	Returns the value of the affectedElements record component.
List<List<ModelPoint>>	affectedRegions()	Returns the value of the affectedRegions 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.
Optional<String>	lintDescription()	Returns the value of the lintDescription record component.
String	lintIdentifier()	Returns the value of the lintIdentifier record component.
String	message()	Returns the value of the message record component.
String	modelKey()	Returns the value of the modelKey record component.
ModelLintSeverity	severity()	Returns the value of the severity record component.
String	title()	Returns the value of the title 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

Constructor Details

ModelLint

public ModelLint(String modelKey,
 String lintIdentifier,
 ModelLintSeverity severity,
 String title,
 String message,
 Optional<String> lintDescription,
 List<UUID> affectedElements,
 List<List<ModelPoint>> affectedRegions)

Creates an instance of a ModelLint record class.

Parameters:

modelKey - the value for the modelKey record component

lintIdentifier - the value for the lintIdentifier record component

severity - the value for the severity record component

title - the value for the title record component

message - the value for the message record component

lintDescription - the value for the lintDescription record component

affectedElements - the value for the affectedElements record component

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

modelKey

public String modelKey()

Returns the value of the modelKey record component.

Returns:

the value of the modelKey record component

lintIdentifier

public String lintIdentifier()

Returns the value of the lintIdentifier record component.

Returns:

the value of the lintIdentifier record component

severity

public ModelLintSeverity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

lintDescription

public Optional<String> lintDescription()

Returns the value of the lintDescription record component.

Returns:

the value of the lintDescription record component

affectedElements

public List<UUID> affectedElements()

Returns the value of the affectedElements record component.

Returns:

the value of the affectedElements record component

affectedRegions

public List<List<ModelPoint>> affectedRegions()

Returns the value of the affectedRegions record component.

Returns:

the value of the affectedRegions record component