Top Description Fields Constructors Methods
org.opentest4j.reporting.tooling.core.validator

public final Record Location

extends Record
Class Inheritance
Annotations
@API
status:EXPERIMENTAL
since:0.1.0
Record Components
path:String
the path of the file
lineNumber:int
the line number
column:int
the column number
Imports
org.apiguardian.api.API

Location of a validation message.
Since
0.1.0

Field Summary

Modifier and TypeField and Description
private final int
column

Record Component accessed by column().

the column number
private final int
lineNumber

Record Component accessed by lineNumber().

the line number
private final String
path

Record Component accessed by path().

the path of the file

Constructor Summary

AccessConstructor and Description
public
Location(String path, int lineNumber, int column)

Method Summary

Modifier and TypeMethod and Description
public int
column()

Record Component getter of column.

Record Component the column number

public final boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public int
lineNumber()

Record Component getter of lineNumber.

Record Component the line number

public String
path()

Record Component getter of path.

Record Component the path of the file

public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

columnback to summary
private final int column

Record Component accessed by column().

the column number

lineNumberback to summary
private final int lineNumber

Record Component accessed by lineNumber().

the line number

pathback to summary
private final String path

Record Component accessed by path().

the path of the file

Constructor Detail

Locationback to summary
public Location(String path, int lineNumber, int column)

Method Detail

columnback to summary
public int column()

Record Component getter of column.

Record Component
the column number
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

lineNumberback to summary
public int lineNumber()

Record Component getter of lineNumber.

Record Component
the line number
pathback to summary
public String path()

Record Component getter of path.

Record Component
the path of the file
toStringback to summary
public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.

Annotations
@Override