Module io.github.ascopes.jct

Package io.github.ascopes.jct.assertions

Class TraceDiagnosticAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<TraceDiagnosticAssert,TraceDiagnostic<? extends JavaFileObject>>

io.github.ascopes.jct.assertions.TraceDiagnosticAssert

All Implemented Interfaces:

Assert<TraceDiagnosticAssert,TraceDiagnostic<? extends JavaFileObject>>, Descriptable<TraceDiagnosticAssert>, ExtensionPoints<TraceDiagnosticAssert,TraceDiagnostic<? extends JavaFileObject>>

@API(since="0.0.1",
     status=STABLE)
public final class TraceDiagnosticAssert
extends AbstractAssert<TraceDiagnosticAssert,TraceDiagnostic<? extends JavaFileObject>>

Assertions for an individual trace diagnostic.

Since:

0.0.1

Author:

Ashley Scopes

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, objects, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Constructor	Description
TraceDiagnosticAssert(@Nullable TraceDiagnostic<? extends JavaFileObject> value)	Initialize this assertion type.

Method Summary

Modifier and Type	Method	Description
AbstractStringAssert<?>	code()	Get assertions for the code of the diagnostic.
AbstractLongAssert<?>	columnNumber()	Get assertions for the column number of the diagnostic.
AbstractLongAssert<?>	endPosition()	Get assertions for the end position of the diagnostic.
DiagnosticKindAssert	kind()	Get assertions for the kind of the diagnostic.
AbstractLongAssert<?>	lineNumber()	Get assertions for the line number of the diagnostic.
AbstractStringAssert<?>	message()	Get assertions for the message of the diagnostic, assuming the default locale.
AbstractStringAssert<?>	message(Locale locale)	Get assertions for the message of the diagnostic.
AbstractLongAssert<?>	position()	Get assertions for the position of the diagnostic.
JavaFileObjectAssert	source()	Get assertions for the source of the diagnostic.
StackTraceAssert	stackTrace()	Get assertions for the stack trace of the location the diagnostic was reported to.
AbstractLongAssert<?>	startPosition()	Get assertions for the start position of the diagnostic.
AbstractLongAssert<?>	threadId()	Get assertions for the thread ID of the thread that reported the diagnostic to the compiler.
AbstractStringAssert<?>	threadName()	Get assertions for the thread name of the thread that reported the diagnostic.
AbstractInstantAssert<?>	timestamp()	Get assertions for the timestamp of the diagnostic.

Methods inherited from class org.assertj.core.api.AbstractAssert

areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assertj.core.api.Descriptable

as, as, as, describedAs, describedAs

Constructor Details

TraceDiagnosticAssert

public TraceDiagnosticAssert(@Nullable TraceDiagnostic<? extends JavaFileObject> value)

Initialize this assertion type.

Parameters:

value - the value to assert on.

Method Details

kind

public DiagnosticKindAssert kind()

Get assertions for the kind of the diagnostic.

Returns:

the assertions for the diagnostic kind.

Throws:

AssertionError - if the diagnostic is null.

source

public JavaFileObjectAssert source()

Get assertions for the source of the diagnostic.

If no source is present, then the value in the returned assertions may be null.

Returns:

the assertions for the source of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

position

public AbstractLongAssert<?> position()

Get assertions for the position of the diagnostic.

The value may be -1 if no information is available.

Returns:

the assertions for the position of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

startPosition

public AbstractLongAssert<?> startPosition()

Get assertions for the start position of the diagnostic.

The value may be -1 if no information is available.

Returns:

the assertions for the start position of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

endPosition

public AbstractLongAssert<?> endPosition()

Get assertions for the end position of the diagnostic.

The value may be -1 if no information is available.

Returns:

the assertions for the end position of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

lineNumber

public AbstractLongAssert<?> lineNumber()

Get assertions for the line number of the diagnostic.

The value may be -1 if no information is available.

Returns:

the assertions for the line number of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

columnNumber

public AbstractLongAssert<?> columnNumber()

Get assertions for the column number of the diagnostic.

The value may be -1 if no information is available.

Returns:

the assertions for the column number of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

code

public AbstractStringAssert<?> code()

Get assertions for the code of the diagnostic.

Returns:

the assertions for the code of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

message

public AbstractStringAssert<?> message()

Get assertions for the message of the diagnostic, assuming the default locale.

Returns:

the assertions for the message of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

message

public AbstractStringAssert<?> message(Locale locale)

Get assertions for the message of the diagnostic.

Parameters:

locale - the locale to use.

Returns:

the assertions for the message of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

timestamp

public AbstractInstantAssert<?> timestamp()

Get assertions for the timestamp of the diagnostic.

Returns:

the assertions for the timestamp of the diagnostic.

Throws:

AssertionError - if the diagnostic is null.

threadId

public AbstractLongAssert<?> threadId()

Get assertions for the thread ID of the thread that reported the diagnostic to the compiler.

Returns:

the assertions for the thread ID.

Throws:

AssertionError - if the diagnostic is null.

threadName

public AbstractStringAssert<?> threadName()

Get assertions for the thread name of the thread that reported the diagnostic.

This may not be present in some situations, in which case the returned assertions will be performed on a null value instead.

Returns:

the assertions for the thread name.

Throws:

AssertionError - if the diagnostic is null.

stackTrace

public StackTraceAssert stackTrace()

Get assertions for the stack trace of the location the diagnostic was reported to.

Returns:

the assertions for the stack trace.

Throws:

AssertionError - if the diagnostic is null.