AssertJ Core 3.26.0 · org.assertj.core.api.AbstractObjectAssert

Modifier and Type	Field and Description
private Map<String, Comparator<?>>	comparatorsByPropertyOrField
private TypeComparators	comparatorsByType

Access	Constructor and Description
public	AbstractObjectAssert(ACTUAL actual, Class<?> selfType)

Method Summary

Modifier and Type	Method and Description
public SELF	as(Description the new description to set. description) Overrides default org.assertj.core.api.Descriptable.as. Sets the description of the assertion that is going to be called after.
public SELF	as(String the new description to set. description, Object... optional parameter if description is a format String. args) Overrides default org.assertj.core.api.Descriptable.as. Sets the description of the assertion that is going to be called after.
public < the expected value type the given `method` returns. T> SELF	Returns: `this` assertion object. doesNotReturn(T the value the object under test method's call should not return. expected, Function<ACTUAL, T> `Function` used to acquire the value to test from the object under test. Must not be `null` from) Verifies that the object under test does not return the given expected value from the given `Function`, a typical usage is to pass a method reference to assert object's property.
public AbstractListAssert<?, List<?>, Object, ObjectAssert<Object>>	Returns: a new assertion object whose object under test is the list containing the extracted properties/fields values extracting(String... the properties/fields to extract from the initial object under test propertiesOrFields) Extracts the values of given fields/properties from the object under test into a list, this new list becoming the object under test.
public AbstractObjectAssert<?, ?>	Returns: a new `ObjectAssert` instance whose object under test is the extracted property/field value extracting(String the property/field to extract from the initial object under test propertyOrField) Extracts the value of given field/property from the object under test, the extracted value becoming the new object under test.
public < the type of the resulting `Assert` ASSERT extends AbstractAssert<?, ?>> ASSERT	Returns: a new narrowed `Assert` instance whose object under test is the extracted property/field value extracting(String the property/field to extract from the initial object under test propertyOrField, InstanceOfAssertFactory<?, ASSERT> the factory which verifies the type and creates the new `Assert` assertFactory) Extracts the value of given field/property from the object under test, the extracted value becoming the new object under test.
public final AbstractListAssert<?, List<?>, Object, ObjectAssert<Object>>	Returns: a new assertion object whose object under test is the list containing the extracted values extracting(Function<? super ACTUAL, ?>... the extractor functions to extract values from the Object under test. extractors) Uses the given `Function`s to extract the values from the object under test into a list, this new list becoming the object under test.
public < the expected extracted value type. T> AbstractObjectAssert<?, T>	Returns: a new `ObjectAssert` instance whose object under test is the extracted value extracting(Function<? super ACTUAL, T> the extractor function used to extract the value from the object under test. extractor) Uses the given `Function` to extract a value from the object under test, the extracted value becoming the new object under test.
public < the expected extracted value type T, the type of the resulting `Assert` ASSERT extends AbstractAssert<?, ?>> ASSERT	Returns: a new narrowed `Assert` instance whose object under test is the extracted value extracting(Function<? super ACTUAL, T> the extractor function used to extract the value from the object under test extractor, InstanceOfAssertFactory<?, ASSERT> the factory which verifies the type and creates the new `Assert` assertFactory) Uses the given `Function` to extract a value from the object under test, the extracted value becoming the new object under test.
protected AbstractListAssert<?, List<?>, Object, ObjectAssert<Object>>	extractingForProxy(Function<? super ACTUAL, ?>[] extractors)
private Objects	getComparatorBasedObjectAssertions(Object value)
protected TypeComparators	getComparatorsByType()
public SELF	Returns: `this` assertion object. hasAllNullFieldsOrProperties() Asserts that the actual object has only null fields or properties.
public SELF	Returns: `this` assertion object. hasAllNullFieldsOrPropertiesExcept(String... properties/fields that won't be checked for not being null. propertiesOrFieldsToIgnore) Asserts that the actual object has only null fields or properties except for the given ones (inherited ones are taken into account).
public SELF	Returns: `this` assertion object. hasFieldOrProperty(String the field/property name to check name) Asserts that the actual object has the specified field or property.
public SELF	Returns: `this` assertion object. hasFieldOrPropertyWithValue(String the field/property name to check name, Object the field/property expected value value) Asserts that the actual object has the specified field or property with the given value.
public SELF	Returns: `this` assertion object. hasNoNullFieldsOrProperties() Asserts that the actual object has no null fields or properties (inherited ones are taken into account).
public SELF	Returns: `this` assertion object. hasNoNullFieldsOrPropertiesExcept(String... properties/fields that won't be checked for null. propertiesOrFieldsToIgnore) Asserts that the actual object has no null fields or properties except for the given ones (inherited ones are taken into account).
public SELF	Returns: `this` assertion object. hasOnlyFields(String... the expected field names actual should have expectedFieldNames) Asserts that the actual object has only the specified fields and nothing else.
public SELF	Returns: `this` assertions object isEqualToComparingFieldByField(Object the object to compare `actual` to. other) Deprecated Use the recursive comparison by calling `usingRecursiveComparison()`.
public SELF	Returns: `this` assertion object. isEqualToComparingFieldByFieldRecursively(Object the object to compare `actual` to. other) Deprecated Prefer calling `usingRecursiveComparison()` for comparing objects field by field as it offers more flexibility, better reporting and an easier to use API.
public SELF	Returns: `this` assertion object. isEqualToComparingOnlyGivenFields(Object the object to compare `actual` to. other, String... properties/fields used in comparison. propertiesOrFieldsUsedInComparison) Deprecated Use the recursive comparison by calling `usingRecursiveComparison()` and specify the fields to ignore.
public SELF	Returns: `this` assertion object. isEqualToIgnoringGivenFields(Object the object to compare `actual` to. other, String... ignored properties/fields to ignore in comparison. propertiesOrFieldsToIgnore) Deprecated Use the recursive comparison by calling `usingRecursiveComparison()` and chain with `ignoringFields(String...)`.
public SELF	Returns: `this` assertion object. isEqualToIgnoringNullFields(Object the object to compare `actual` to. other) Deprecated Use the recursive comparison by calling `usingRecursiveComparison()` and chain with `ignoringExpectedNullFields()`.
protected <T> AbstractObjectAssert<?, T>	newObjectAssert(T objectUnderTest)
public < the expected value type the given `method` returns. T> SELF	Returns: `this` assertion object. returns(T the value the object under test method's call should return. expected, Function<ACTUAL, T> `Function` used to acquire the value to test from the object under test. Must not be `null` from) Verifies that the object under test returns the given expected value from the given `Function`, a typical usage is to pass a method reference to assert object's property.
public < the type of values to compare. T> SELF	Returns: `this` assertions object usingComparatorForFields(Comparator<T> the `Comparator` to use comparator, String... the names of the properties and/or fields the comparator should be used for propertiesOrFields) Allows to set a specific comparator to compare properties or fields with the given names.
public < the type of objects that the comparator should be used for T> SELF	Returns: `this` assertions object usingComparatorForType(Comparator<? super T> the `Comparator` to use comparator, Class<T> the `Class` of the type the comparator should be used for type) Allows to set a specific comparator to compare properties or fields with the given type.
public RecursiveAssertionAssert	Returns: A new instance of `RecursiveAssertionAssert` built with a default `RecursiveAssertionConfiguration`. usingRecursiveAssertion() Overrides org.assertj.core.api.AbstractAssert.usingRecursiveAssertion. Asserts that the given predicate is met for all fields of the object under test recursively (but not the object itself).
public RecursiveAssertionAssert	Returns: A new instance of `RecursiveAssertionAssert` built with a default `RecursiveAssertionConfiguration`. usingRecursiveAssertion(RecursiveAssertionConfiguration The recursion configuration described above. recursiveAssertionConfiguration) Overrides org.assertj.core.api.AbstractAssert.usingRecursiveAssertion. The same as `usingRecursiveAssertion()`, but this method allows the developer to pass in an explicit recursion configuration.
public RecursiveComparisonAssert<?>	Returns: a new `RecursiveComparisonAssert` instance usingRecursiveComparison() Overrides org.assertj.core.api.AbstractAssert.usingRecursiveComparison. Enable using a recursive field by field comparison strategy when calling the chained `isEqualTo` assertion.
public RecursiveComparisonAssert<?>	Returns: a new `RecursiveComparisonAssert` instance built with the given `RecursiveComparisonConfiguration`. usingRecursiveComparison(RecursiveComparisonConfiguration the `RecursiveComparisonConfiguration` used in the chained `isEqualTo` assertion. recursiveComparisonConfiguration) Overrides org.assertj.core.api.AbstractAssert.usingRecursiveComparison. Same as `usingRecursiveComparison()` but allows to specify your own `RecursiveComparisonConfiguration`.
pack-priv SELF	withAssertionState(AbstractAssert<SELF extends AbstractAssert<SELF, ACTUAL>, ACTUAL> assertInstance) Overrides org.assertj.core.api.AbstractAssert.withAssertionState.
pack-priv SELF	withComparatorByPropertyOrField(Map<String, Comparator<?>> comparatorsToPropaget)
pack-priv SELF	withTypeComparator(TypeComparators comparatorsByType)

Inherited from 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 withFailMessage withFailMessage withRepresentation withThreadDumpOnError

public abstract Class AbstractObjectAssert<SELF extends AbstractObjectAssert<SELF, ACTUAL>, ACTUAL>

Field Summary

Constructor Summary

Method Summary