net.neoforged.problems

Class ProblemLocation

java.lang.Object

net.neoforged.problems.ProblemLocation

public final class ProblemLocation
extends java.lang.Object

Identifies the location of a problem in a file.

Inspired by https://docs.gradle.org/8.14/javadoc/org/gradle/api/problems/ProblemLocation.html

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.Integer	column()
boolean	equals(java.lang.Object obj)
java.nio.file.Path	file()
int	hashCode()
@Nullable java.lang.Integer	length() Optionally specifies the length in bytes (for offset()) or characters (for column()) of the problems' location.
@Nullable java.lang.Integer	line()
static ProblemLocation	ofFile(java.nio.file.Path file)
@Nullable java.lang.Integer	offset() 0-based byte-offset in file().
static ProblemLocation	ofLocationInFile(java.nio.file.Path file, int line)
static ProblemLocation	ofLocationInFile(java.nio.file.Path file, int line, int column)
static ProblemLocation	ofLocationInFile(java.nio.file.Path file, int line, int column, int length)
static ProblemLocation	ofOffsetInFile(java.nio.file.Path file, int offset, int length)
java.lang.String	toString()
ProblemLocation	withFile(java.nio.file.Path file) Copies this location and replaces the file path found in the copy.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

ofFile

public static ProblemLocation ofFile(java.nio.file.Path file)

ofLocationInFile

public static ProblemLocation ofLocationInFile(java.nio.file.Path file,
                                               int line)

Parameters:

line - 1-based line number.

ofLocationInFile

public static ProblemLocation ofLocationInFile(java.nio.file.Path file,
                                               int line,
                                               int column)

Parameters:

line - 1-based line number.

column - 1-based column number.

ofLocationInFile

public static ProblemLocation ofLocationInFile(java.nio.file.Path file,
                                               int line,
                                               int column,
                                               int length)

Parameters:

line - 1-based line number.

column - 1-based column number.

ofOffsetInFile

public static ProblemLocation ofOffsetInFile(java.nio.file.Path file,
                                             int offset,
                                             int length)

Parameters:

offset - 0-based byte offset into the file.

length - Number of bytes starting at offset that are relevant to the problem. May be 0.

withFile

public ProblemLocation withFile(java.nio.file.Path file)

Copies this location and replaces the file path found in the copy.

file

public java.nio.file.Path file()

line

@Nullable
public @Nullable java.lang.Integer line()

Returns:

1-based line offset into the file().

Mutually exclusive with offset().

column

@Nullable
public @Nullable java.lang.Integer column()

Returns:

1-based character offset into the line specified by line().

offset

@Nullable
public @Nullable java.lang.Integer offset()

0-based byte-offset in file().

Mutually exclusive with line() and column().

length

@Nullable
public @Nullable java.lang.Integer length()

Optionally specifies the length in bytes (for offset()) or characters (for column()) of the problems' location.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object