## Uses of Interface
de.gebit.integrity.comparator.ComparisonResult

- Packages that use ComparisonResult
  Package | Description
  --- | ---
  de.gebit.integrity.comparator |
  de.gebit.integrity.fixtures |
  de.gebit.integrity.parameter.conversion |
  de.gebit.integrity.runner.comparator |
  de.gebit.integrity.runner.results.test |

- - ### Uses of ComparisonResult in de.gebit.integrity.comparator

    Classes in de.gebit.integrity.comparator that implement ComparisonResult
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `MapComparisonResult` | A comparison result of a map comparison.
    `class` | `SimpleComparisonResult` | The most basic comparison result.

  - ### Uses of ComparisonResult in de.gebit.integrity.fixtures

    Methods in de.gebit.integrity.fixtures that return ComparisonResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ComparisonResult` | CustomComparatorFixture.`compareResults​(Object anExpectedResult, Object aFixtureResult, String aMethodName, String aPropertyName)` | Compares an expected result with an actual result obtained by calling the respective fixture method.
    `ComparisonResult` | FixtureWrapper.`performCustomComparation​(Object anExpectedResult, Object aFixtureResult, String aMethodName, String aPropertyName)` | Performs a custom comparation using the wrapped fixture, which must be a `CustomComparatorFixture`.

  - ### Uses of ComparisonResult in de.gebit.integrity.parameter.conversion

    Fields in de.gebit.integrity.parameter.conversion declared as ComparisonResult
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected ComparisonResult` | ConversionContext.`comparisonResult` | In case of a value being converted which belongs to a comparison that has been executed, the result of said comparison can be provided.

    Methods in de.gebit.integrity.parameter.conversion that return ComparisonResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ComparisonResult` | ConversionContext.`getComparisonResult()` |

    Methods in de.gebit.integrity.parameter.conversion with parameters of type ComparisonResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ConversionContext` | ConversionContext.`withComparisonResult​(ComparisonResult aComparisonResult)` | Adds the provided comparison result.

  - ### Uses of ComparisonResult in de.gebit.integrity.runner.comparator

    Methods in de.gebit.integrity.runner.comparator that return ComparisonResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ComparisonResult` | DefaultResultComparator.`compareResult​(Object aFixtureResult, ValueOrEnumValueOrOperationCollection anExpectedResult, FixtureWrapper<?> aFixtureInstance, MethodReference aFixtureMethod, String aPropertyName)` |
    `ComparisonResult` | ResultComparator.`compareResult​(Object aFixtureResult, ValueOrEnumValueOrOperationCollection anExpectedResult, FixtureWrapper<?> aFixtureInstance, MethodReference aFixtureMethod, String aPropertyName)` | Compares the expected result with the actual result obtained from a test fixture.
    `protected ComparisonResult` | DefaultResultComparator.`convertAndPerformEqualityCheck​(Object aSingleFixtureResult, ValueOrEnumValueOrOperation aSingleExpectedResult, Class<?> aConversionTargetType)` | Converts a fixture result and an expected result value for comparison (usually by converting the expected result to match the fixture result, but nested objects are handled differently and converted to maps for comparison).
    `protected ComparisonResult` | DefaultResultComparator.`convertAndPerformEqualityCheck​(Object aSingleFixtureResult, Object aSingleExpectedResult, ValueOrEnumValueOrOperation anOriginalSingleExpectedResult, Class<?> aConversionTargetType, boolean anExpectedResultWasEmptyOptionalFlag)` |
    `protected ComparisonResult` | DefaultResultComparator.`performEqualityCheck​(Object aConvertedResult, Object aConvertedExpectedResult, ValueOrEnumValueOrOperation aRawExpectedResult)` | Perform the actual equality check between a real result returned from a fixture and a converted result gathered from the test scripts.
    `protected ComparisonResult` | DefaultResultComparator.`performEqualityCheckForDates​(Date aResult, Date anExpectedResult, Object aRawExpectedResult)` | Compare two `Date`s for equality.
    `protected ComparisonResult` | DefaultResultComparator.`performEqualityCheckForJava8Dates​(Temporal aResult, Temporal anExpectedResult, Object aRawExpectedResult)` | Compare two `Temporal`s for equality.
    `protected ComparisonResult` | DefaultResultComparator.`performEqualityCheckForObjects​(Object aResult, Object anExpectedResult, Object aRawExpectedResult)` | Compare two objects.
    `protected ComparisonResult` | DefaultResultComparator.`performRegexCheck​(String aFixtureResult, RegexValue anExpectedResult)` | Performs the regular expression based comparison between a fixture result and an expected regex.

  - ### Uses of ComparisonResult in de.gebit.integrity.runner.results.test

    Methods in de.gebit.integrity.runner.results.test that return ComparisonResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ComparisonResult` | TestComparisonResult.`getResult()` |

    Methods in de.gebit.integrity.runner.results.test with parameters of type ComparisonResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `static TestComparisonResult` | TestComparisonResult.`wrap​(ComparisonResult aResult, String aParameter, Object anActualValue, ValueOrEnumValueOrOperationCollection anExpectedValue)` | Convenience method to wrap a `ComparisonResult`.

    Constructors in de.gebit.integrity.runner.results.test with parameters of type ComparisonResult
    Constructor | Description
    --- | ---
    `TestComparisonFailureResult​(ComparisonResult aResult, String aParameter, Object anActualValue, ValueOrEnumValueOrOperationCollection anExpectedValue)` | Creates a new instance.
    `TestComparisonResult​(ComparisonResult aResult, String aParameter, Object anActualValue, ValueOrEnumValueOrOperationCollection anExpectedValue)` | Creates an instance.
    `TestComparisonSuccessResult​(ComparisonResult aResult, String aParameter, Object anActualValue, ValueOrEnumValueOrOperationCollection anExpectedValue)` | Creates a new instance.