Package org.assertj.vavr.api

Class ValidationAssert<INVALID,​VALID>

  • Type Parameters:
    INVALID - type of the value in the case of the invalid Validation.
    VALID - type of the value in the case of the valid Validation.
    All Implemented Interfaces:
    org.assertj.core.api.Assert<ValidationAssert<INVALID,​VALID>,​io.vavr.control.Validation<INVALID,​VALID>>, org.assertj.core.api.Descriptable<ValidationAssert<INVALID,​VALID>>, org.assertj.core.api.ExtensionPoints<ValidationAssert<INVALID,​VALID>,​io.vavr.control.Validation<INVALID,​VALID>>
    public class ValidationAssert<INVALID,​VALID>
extends org.assertj.core.api.AbstractObjectAssert<SELF,​ACTUAL>
    Assertions for Validation.
    Author:
    Michał Chmielarz

    • Field Summary

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

        actual, info, myself, throwUnsupportedExceptionOnEquals

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ACTUAL actual()  
      SELF containsInvalid​(INVALID expectedErrorValue)
      Verifies that the actual Validation is Validation.Invalid and contains the given error value.
      SELF containsInvalidInstanceOf​(Class<?> clazz)
      Verifies that the actual invalid Validation contains a value that is an instance of the argument.
      SELF containsInvalidSame​(VALID expectedErrorValue)
      Verifies that the actual invalid Validation contains the instance given as an argument.
      SELF containsValid​(VALID expectedValue)
      Verifies that the actual Validation is Validation.Valid and contains the given value.
      SELF containsValidInstanceOf​(Class<?> clazz)
      Verifies that the actual valid Validation contains a value that is an instance of the argument.
      SELF containsValidSame​(VALID expectedValue)
      Verifies that the actual valid Validation contains the instance given as an argument.
      org.assertj.core.api.WritableAssertionInfo info()  
      SELF isInvalid()
      Verifies that the actual Validation is invalid.
      SELF isValid()
      Verifies that the actual Validation is valid.
      org.assertj.core.internal.Objects objects()  
      SELF usingDefaultRightValueComparator()
      Revert to standard comparison for incoming assertion Validation value checks.
      SELF usingFieldByFieldValueComparator()
      Use field/property by field/property comparison (including inherited fields/properties) instead of relying on actual type A equals method to compare the Validation value's object for incoming assertion checks.
      SELF usingValueComparator​(Comparator<?> customComparator)
      Use given custom comparator instead of relying on actual type A equals method to compare the Validation value's object for incoming assertion checks.
      SELF withAssertionState​(org.assertj.vavr.api.AbstractVavrAssert assertInstance)  

      • Methods inherited from class org.assertj.core.api.AbstractObjectAssert

        as, as, extracting, extracting, extracting, extracting, extracting, extracting, getComparatorsByType, hasAllNullFieldsOrProperties, hasAllNullFieldsOrPropertiesExcept, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, hasOnlyFields, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, newObjectAssert, returns, usingComparatorForFields, usingComparatorForType, usingRecursiveComparison, usingRecursiveComparison

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

        asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, 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, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOf, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

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

        as, describedAs

    • Method Detail

      • isInvalid

        public SELF isInvalid()
        Verifies that the actual Validation is invalid.
        Returns:
        this assertion object.

      • isValid

        public SELF isValid()
        Verifies that the actual Validation is valid.
        Returns:
        this assertion object.

      • containsValid

        public SELF containsValid​(VALID expectedValue)
        Verifies that the actual Validation is Validation.Valid and contains the given value.
        Parameters:
        expectedValue - the expected value inside the Validation.
        Returns:
        this assertion object.

      • containsInvalid

        public SELF containsInvalid​(INVALID expectedErrorValue)
        Verifies that the actual Validation is Validation.Invalid and contains the given error value.
        Parameters:
        expectedErrorValue - the expected error value inside the Validation.
        Returns:
        this assertion object.

      • containsValidSame

        public SELF containsValidSame​(VALID expectedValue)
        Verifies that the actual valid Validation contains the instance given as an argument.
        Parameters:
        expectedValue - the expected value inside the Validation.
        Returns:
        this assertion object.

      • containsInvalidSame

        public SELF containsInvalidSame​(VALID expectedErrorValue)
        Verifies that the actual invalid Validation contains the instance given as an argument.
        Parameters:
        expectedErrorValue - the expected value inside the Validation.
        Returns:
        this assertion object.

      • containsValidInstanceOf

        public SELF containsValidInstanceOf​(Class<?> clazz)
        Verifies that the actual valid Validation contains a value that is an instance of the argument.
        Parameters:
        clazz - the expected class of the value inside the valid Validation.
        Returns:
        this assertion object.

      • containsInvalidInstanceOf

        public SELF containsInvalidInstanceOf​(Class<?> clazz)
        Verifies that the actual invalid Validation contains a value that is an instance of the argument.
        Parameters:
        clazz - the expected class of the value inside the invalid Validation.
        Returns:
        this assertion object.

      • usingValueComparator

        public SELF usingValueComparator​(Comparator<?> customComparator)
        Use given custom comparator instead of relying on actual type A equals method to compare the Validation value's object for incoming assertion checks.
        Parameters:
        customComparator - the comparator to use for incoming assertion checks.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given comparator is null.

      • usingFieldByFieldValueComparator

        public SELF usingFieldByFieldValueComparator()
        Use field/property by field/property comparison (including inherited fields/properties) instead of relying on actual type A equals method to compare the Validation value's object for incoming assertion checks. Private fields are included but this can be disabled using Assertions.setAllowExtractingPrivateFields(boolean).
        Returns:
        this assertion object.

      • usingDefaultRightValueComparator

        public SELF usingDefaultRightValueComparator()
        Revert to standard comparison for incoming assertion Validation value checks.

        This method should be used to disable a custom comparison strategy set by calling usingValueComparator(Comparator).

        Returns:
        this assertion object.

      • actual

        public ACTUAL actual()

      • withAssertionState

        public SELF withAssertionState​(org.assertj.vavr.api.AbstractVavrAssert assertInstance)

      • objects

        public org.assertj.core.internal.Objects objects()

      • info

        public org.assertj.core.api.WritableAssertionInfo info()