Package io.wcm.caravan.hal.comparison
Interface HalComparison
-
@ProviderType public interface HalComparison
An OSGi service to recursively compare two asynchronously loaded trees of HAL+JSON resources.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description rx.Observable<HalDifference>
compare(HalComparisonSource expected, HalComparisonSource actual, HalComparisonStrategy strategy)
Recursively crawl and compare the linked and embeddedHalResource
s from two different HAL API entry points.
-
-
-
Method Detail
-
compare
rx.Observable<HalDifference> compare(HalComparisonSource expected, HalComparisonSource actual, HalComparisonStrategy strategy)
Recursively crawl and compare the linked and embeddedHalResource
s from two different HAL API entry points.- Parameters:
expected
- aHalComparisonSource
that provides the ground truth for the comparisonactual
- aHalComparisonSource
that provides the resources that should be compared with the expected resourcesstrategy
- can be implemented to limit the crawling and comparison depth (e.g. ignore specific link relations)- Returns:
- an
Observable
that emits oneHalDifference
object for each difference that was detected
-
-