Module io.github.ascopes.jct

Package io.github.ascopes.jct.assertions

Class JctAssertions

java.lang.Object

io.github.ascopes.jct.utils.UtilityClass

io.github.ascopes.jct.assertions.JctAssertions

@API(since="0.0.1",
     status=STABLE)
public final class JctAssertions
extends io.github.ascopes.jct.utils.UtilityClass

Helper class to provide fluent creation of assertions for compilations.

Since:

0.0.1

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
static JctCompilationAssert	assertThat(@Nullable JctCompilation compilation)	Perform an assertion on a compilation.
static ModuleContainerGroupAssert	assertThat(@Nullable ModuleContainerGroup moduleContainerGroup)	Perform an assertion on a module container group.
static OutputContainerGroupAssert	assertThat(@Nullable OutputContainerGroup outputContainerGroup)	Perform an assertion on an output container group.
static PackageContainerGroupAssert	assertThat(@Nullable PackageContainerGroup packageContainerGroup)	Perform an assertion on a package container group.
static TraceDiagnosticAssert	assertThat(@Nullable TraceDiagnostic<? extends JavaFileObject> diagnostic)	Perform an assertion on a diagnostic.
static PathFileObjectAssert	assertThat(@Nullable PathFileObject fileObject)	Perform an assertion on a Path-based Java file object.
static JavaFileObjectAssert	assertThat(@Nullable JavaFileObject fileObject)	Perform an assertion on a Java file object.
static DiagnosticKindAssert	assertThat(@Nullable Diagnostic.Kind kind)	Perform an assertion on a diagnostic kind.
static LocationAssert	assertThat(@Nullable JavaFileManager.Location location)	Perform an assertion on a location.
static JavaFileObjectKindAssert	assertThat(@Nullable JavaFileObject.Kind kind)	Perform an assertion on a Java file object kind.
static JctCompilationAssert	assertThatCompilation(@Nullable JctCompilation compilation)	Perform an assertion on a compilation.
static ModuleContainerGroupAssert	assertThatContainerGroup(@Nullable ModuleContainerGroup moduleContainerGroup)	Perform an assertion on a module container group.
static OutputContainerGroupAssert	assertThatContainerGroup(@Nullable OutputContainerGroup outputContainerGroup)	Perform an assertion on an output container group.
static PackageContainerGroupAssert	assertThatContainerGroup(@Nullable PackageContainerGroup packageContainerGroup)	Perform an assertion on a package container group.
static TraceDiagnosticAssert	assertThatDiagnostic(@Nullable TraceDiagnostic<? extends JavaFileObject> diagnostic)	Perform an assertion on a diagnostic.
static TraceDiagnosticListAssert	assertThatDiagnostics(@Nullable List<? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics)	Perform an assertion on a list of diagnostics.
static PathFileObjectAssert	assertThatFileObject(@Nullable PathFileObject fileObject)	Perform an assertion on a Path-based Java file object.
static JavaFileObjectAssert	assertThatFileObject(@Nullable JavaFileObject fileObject)	Perform an assertion on a Java file object.
static DiagnosticKindAssert	assertThatKind(@Nullable Diagnostic.Kind kind)	Perform an assertion on a diagnostic kind.
static JavaFileObjectKindAssert	assertThatKind(@Nullable JavaFileObject.Kind kind)	Perform an assertion on a Java file object kind.
static LocationAssert	assertThatLocation(@Nullable JavaFileManager.Location location)	Perform an assertion on a location.

Methods inherited from class java.lang.Object

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

Method Details

assertThat

public static JctCompilationAssert assertThat(@Nullable JctCompilation compilation)

Perform an assertion on a compilation.

This is a shorthand alias for assertThatCompilation(JctCompilation). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

compilation - the compilation to assert on.

Returns:

the assertion.

assertThat

public static ModuleContainerGroupAssert assertThat(@Nullable ModuleContainerGroup moduleContainerGroup)

Perform an assertion on a module container group.

This is a shorthand alias for assertThatContainerGroup(ModuleContainerGroup). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

moduleContainerGroup - the module container group to assert on.

Returns:

the assertion.

assertThat

public static OutputContainerGroupAssert assertThat(@Nullable OutputContainerGroup outputContainerGroup)

Perform an assertion on an output container group.

This is a shorthand alias for assertThatContainerGroup(OutputContainerGroup). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

outputContainerGroup - the output container group to assert on.

Returns:

the assertion.

assertThat

public static PackageContainerGroupAssert assertThat(@Nullable PackageContainerGroup packageContainerGroup)

Perform an assertion on a package container group.

This is a shorthand alias for assertThatContainerGroup(PackageContainerGroup). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

packageContainerGroup - the package container group to assert on.

Returns:

the assertion.

assertThat

public static TraceDiagnosticAssert assertThat(@Nullable TraceDiagnostic<? extends JavaFileObject> diagnostic)

Perform an assertion on a diagnostic.

This is a shorthand alias for assertThatDiagnostic(TraceDiagnostic). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

diagnostic - the diagnostic to assert on.

Returns:

the assertion.

assertThat

public static JavaFileObjectAssert assertThat(@Nullable JavaFileObject fileObject)

Perform an assertion on a Java file object.

This is a shorthand alias for assertThatFileObject(JavaFileObject). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

fileObject - the file object to assert on.

Returns:

the assertion.

assertThat

public static PathFileObjectAssert assertThat(@Nullable PathFileObject fileObject)

Perform an assertion on a Path-based Java file object.

This is a shorthand alias for assertThatFileObject(PathFileObject). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

fileObject - the file object to assert on.

Returns:

the assertion.

assertThat

public static DiagnosticKindAssert assertThat(@Nullable Diagnostic.Kind kind)

Perform an assertion on a diagnostic kind.

This is a shorthand alias for assertThatKind(Diagnostic.Kind). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

kind - the diagnostic kind to assert on.

Returns:

the assertion.

assertThat

public static JavaFileObjectKindAssert assertThat(@Nullable JavaFileObject.Kind kind)

Perform an assertion on a Java file object kind.

This is a shorthand alias for assertThatKind(JavaFileObject.Kind). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

kind - the Java file object kind to assert on.

Returns:

the assertion.

assertThat

public static LocationAssert assertThat(@Nullable JavaFileManager.Location location)

Perform an assertion on a location.

This is a shorthand alias for assertThatLocation(Location). If you are using AssertJ assertions in your tests with static imports, you may wish to use that instead to prevent name conflicts.

Parameters:

location - the location to assert on.

Returns:

the assertion.

assertThatCompilation

public static JctCompilationAssert assertThatCompilation(@Nullable JctCompilation compilation)

Perform an assertion on a compilation.

Parameters:

compilation - the compilation to assert on.

Returns:

the assertion.

assertThatContainerGroup

public static ModuleContainerGroupAssert assertThatContainerGroup(@Nullable ModuleContainerGroup moduleContainerGroup)

Perform an assertion on a module container group.

Parameters:

moduleContainerGroup - the module container group to assert on.

Returns:

the assertion.

assertThatContainerGroup

public static OutputContainerGroupAssert assertThatContainerGroup(@Nullable OutputContainerGroup outputContainerGroup)

Perform an assertion on an output container group.

Parameters:

outputContainerGroup - the output container group to assert on.

Returns:

the assertion.

assertThatContainerGroup

public static PackageContainerGroupAssert assertThatContainerGroup(@Nullable PackageContainerGroup packageContainerGroup)

Perform an assertion on a package container group.

Parameters:

packageContainerGroup - the package container group to assert on.

Returns:

the assertion.

assertThatDiagnostic

public static TraceDiagnosticAssert assertThatDiagnostic(@Nullable TraceDiagnostic<? extends JavaFileObject> diagnostic)

Perform an assertion on a diagnostic.

Parameters:

diagnostic - the diagnostic to assert on.

Returns:

the assertion.

assertThatDiagnostics

public static TraceDiagnosticListAssert assertThatDiagnostics(@Nullable List<? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics)

Perform an assertion on a list of diagnostics.

Parameters:

diagnostics - the diagnostics to assert on.

Returns:

the assertion.

assertThatFileObject

public static JavaFileObjectAssert assertThatFileObject(@Nullable JavaFileObject fileObject)

Perform an assertion on a Java file object.

Parameters:

fileObject - the file object to assert on.

Returns:

the assertion.

assertThatFileObject

public static PathFileObjectAssert assertThatFileObject(@Nullable PathFileObject fileObject)

Perform an assertion on a Path-based Java file object.

Parameters:

fileObject - the file object to assert on.

Returns:

the assertion.

assertThatKind

public static DiagnosticKindAssert assertThatKind(@Nullable Diagnostic.Kind kind)

Perform an assertion on a diagnostic kind.

Parameters:

kind - the diagnostic kind to assert on.

Returns:

the assertion.

assertThatKind

public static JavaFileObjectKindAssert assertThatKind(@Nullable JavaFileObject.Kind kind)

Perform an assertion on a Java file object kind.

Parameters:

kind - the Java file object kind to assert on.

Returns:

the assertion.

assertThatLocation

public static LocationAssert assertThatLocation(@Nullable JavaFileManager.Location location)

Perform an assertion on a location.

Parameters:

location - the location to assert on.

Returns:

the assertion.