Module io.github.ascopes.jct

Package io.github.ascopes.jct.diagnostics

Class TraceDiagnostic<S extends JavaFileObject>

java.lang.Object

io.github.ascopes.jct.diagnostics.TraceDiagnostic<S>

Type Parameters:

S - the file type.

All Implemented Interfaces:

Diagnostic<S>

@API(since="0.0.1",
     status=STABLE)
public class TraceDiagnostic<S extends JavaFileObject>
extends Object
implements Diagnostic<S>

A wrapper around a Diagnostic which contains additional information about where the diagnostic was reported.

Since:

0.0.1

Author:

Ashley Scopes

Nested Class Summary

Nested classes/interfaces inherited from interface javax.tools.Diagnostic

Diagnostic.Kind

Field Summary

Fields inherited from interface javax.tools.Diagnostic

NOPOS

Constructor Summary

Constructors

Constructor	Description
TraceDiagnostic(Instant timestamp, long threadId, @Nullable String threadName, List<StackTraceElement> stackTrace, Diagnostic<? extends S> original)	Initialize this diagnostic.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getCode()
long	getColumnNumber()
long	getEndPosition()
Diagnostic.Kind	getKind()
long	getLineNumber()
String	getMessage(@Nullable Locale locale)
long	getPosition()
@Nullable S	getSource()
List<StackTraceElement>	getStackTrace()	Get the stacktrace of where the diagnostic was written from.
long	getStartPosition()
long	getThreadId()	Get the thread ID for the thread that created this diagnostic.
@Nullable String	getThreadName()	Get the thread name for the thread that created this diagnostic.
Instant	getTimestamp()	Get the timestamp that the diagnostic was created at.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TraceDiagnostic

public TraceDiagnostic(Instant timestamp,
 long threadId,
 @Nullable String threadName,
 List<StackTraceElement> stackTrace,
 Diagnostic<? extends S> original)

Initialize this diagnostic.

Parameters:

timestamp - the timestamp.

threadId - the thread ID.

threadName - the thread name, or null if not known.

stackTrace - the stacktrace.

original - the original diagnostic that was reported.

Method Details

getKind

public Diagnostic.Kind getKind()

Specified by:

getKind in interface Diagnostic<S extends JavaFileObject>

getSource

public @Nullable S getSource()

Specified by:

getSource in interface Diagnostic<S extends JavaFileObject>

getPosition

public long getPosition()

Specified by:

getPosition in interface Diagnostic<S extends JavaFileObject>

getStartPosition

public long getStartPosition()

Specified by:

getStartPosition in interface Diagnostic<S extends JavaFileObject>

getEndPosition

public long getEndPosition()

Specified by:

getEndPosition in interface Diagnostic<S extends JavaFileObject>

getLineNumber

public long getLineNumber()

Specified by:

getLineNumber in interface Diagnostic<S extends JavaFileObject>

getColumnNumber

public long getColumnNumber()

Specified by:

getColumnNumber in interface Diagnostic<S extends JavaFileObject>

getCode

public @Nullable String getCode()

Specified by:

getCode in interface Diagnostic<S extends JavaFileObject>

getMessage

public String getMessage(@Nullable Locale locale)

Specified by:

getMessage in interface Diagnostic<S extends JavaFileObject>

getTimestamp

public Instant getTimestamp()

Get the timestamp that the diagnostic was created at.

Returns:

the diagnostic timestamp.

getThreadId

public long getThreadId()

Get the thread ID for the thread that created this diagnostic.

Returns:

the thread ID.

getThreadName

public @Nullable String getThreadName()

Get the thread name for the thread that created this diagnostic.

Returns:

the thread name, if known, or else null.

getStackTrace

public List<StackTraceElement> getStackTrace()

Get the stacktrace of where the diagnostic was written from.

Returns:

the stacktrace, in an unmodifiable list.

toString

public String toString()

Overrides:

toString in class Object