Record Class BimApi.QueryValidationMessage

java.lang.Object

java.lang.Record

nl.bimbase.bimworks.client.apis.BimApi.QueryValidationMessage

Record Components:

code - the check that found it (unknownIfcClass, invalidRegex, ...) or FEATURE_NOT_VISIBLE; null for a check without a code

severity - ERROR or WARNING

line - 1-based, 0 when unknown

column - 1-based, 0 when unknown

message - "line L:C: ...", as the editor and the chat show it

Enclosing class:

BimApi

public static record BimApi.QueryValidationMessage(String code, String severity, int line, int column, String message)
extends Record

One finding of BimApi.validateQuery(String): what the editor marks in a query that parses.

Constructor Summary

Constructors

Constructor	Description
QueryValidationMessage(String code, String severity, int line, int column, String message)	Creates an instance of a QueryValidationMessage record class.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the value of the code record component.
int	column()	Returns the value of the column 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.
int	line()	Returns the value of the line record component.
String	message()	Returns the value of the message record component.
String	severity()	Returns the value of the severity 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

QueryValidationMessage

public QueryValidationMessage(String code,
 String severity,
 int line,
 int column,
 String message)

Creates an instance of a QueryValidationMessage record class.

Parameters:

code - the value for the code record component

severity - the value for the severity record component

line - the value for the line record component

column - the value for the column record component

message - the value for the message 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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

severity

public String severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

line

public int line()

Returns the value of the line record component.

Returns:

the value of the line record component

column

public int column()

Returns the value of the column record component.

Returns:

the value of the column record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component