Module io.github.ascopes.jct

Package io.github.ascopes.jct.assertions

Class PathFileObjectAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<PathFileObjectAssert,PathFileObject>

io.github.ascopes.jct.assertions.AbstractJavaFileObjectAssert<PathFileObjectAssert,PathFileObject>

io.github.ascopes.jct.assertions.PathFileObjectAssert

All Implemented Interfaces:

Assert<PathFileObjectAssert,PathFileObject>, Descriptable<PathFileObjectAssert>, ExtensionPoints<PathFileObjectAssert,PathFileObject>

@API(since="0.0.1",
     status=STABLE)
public final class PathFileObjectAssert
extends AbstractJavaFileObjectAssert<PathFileObjectAssert,PathFileObject>

Assertions for Path file objects.

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
PathFileObjectAssert(@Nullable PathFileObject actual)	Create a new instance of this assertion object.

Method Summary

Modifier and Type	Method	Description
AbstractPathAssert<?>	absolutePath()	Perform an assertion on the file object's absolute path.
AbstractPathAssert<?>	relativePath()	Perform an assertion on the file object's relative path.

Methods inherited from class io.github.ascopes.jct.assertions.AbstractJavaFileObjectAssert

binaryContent, content, content, content, kind, lastModified, name, uri

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

PathFileObjectAssert

public PathFileObjectAssert(@Nullable PathFileObject actual)

Create a new instance of this assertion object.

Parameters:

actual - the path file object to assert upon.

Method Details

relativePath

public AbstractPathAssert<?> relativePath()

Perform an assertion on the file object's relative path.

The path is relative to the base directory holding all the sources relative to their package names.

Returns:

the assertions for the path.

Throws:

AssertionError - if the file object is null.

absolutePath

public AbstractPathAssert<?> absolutePath()

Perform an assertion on the file object's absolute path.

You generally should prefer using relativePath().

Returns:

the assertions for the path.

Throws:

AssertionError - if the file object is null.