- subRule: jsonPath: $.userextensible: truestrictOrder: trueignoreNull: truefastFail: falsecustomRules: # Apply number precision comparison to age fields - name: NumberPrecisejsonPath: "**.age"param: "newScale=3,roundingMode=3"# Ignore timestamp field during comparison - name: IngorePathparam: "user.queryTimestamp"# Compare position values with tolerance - name: ImprecisePositionjsonPath: ""param: "tolerance=0.01;separator=," - subRule: jsonPath: $.ordersStrictOrderextensible: truestrictOrder: truecustomRules: - name: ArrayWithKeyjsonPath: "$"param: "key=orderId" - subRule: jsonPath: $.ordersWithoutOrderextensible: truestrictOrder: falsecustomRules: - name: ArrayDisorderjsonPath: "$"

- subRule: # JSONPath expression to specify which part of the JSON to apply this rule tojsonPath: $.user# Whether the target JSON can have additional fields not present in the expected JSONextensible: true# Whether arrays should be compared in strict order (true) or allow reordering (false)strictOrder: true# Whether to ignore null values during comparisonignoreNull: true# Whether to stop comparison immediately when first difference is foundfastFail: falsepreProcess: # TODO# Remove specific nodes from JSON before comparisonremoveNode: jsonPath: ""# Custom comparison rules to apply to this JSONPathcustomRules: # Apply number precision comparison to all age fields (3 decimal places, rounding mode 3) - name: NumberPrecisejsonPath: "**.age"param: "newScale=3,roundingMode=3"# Compare arrays using a specific key field for matching elements - name: ArrayWithKeyjsonPath: "$"param: "key=id"# Ignore specific paths during comparison - name: IngorePathparam: "user.queryTimestamp"# Allow array elements to be in any order - name: ArrayDisorderjsonPath: "**.ordersWithoutOrder"# Recursively compare array elements - name: ArrayRecursivelyjsonPath: param: # Compare degree values with specified tolerance - name: DegreePrecisejsonPath: param: "tolerance=10e-1"# Compare radian values with specified tolerance - name: RadianPrecisejsonPath: param: "tolerance=10e-4"# Compare values with tolerance for floating point differences - name: TolerantValuejsonPath: ""param: "tolerance=10e-4"# Compare values with percentage-based tolerance - name: PercentTolerantjsonPath: ""param: "tolerance=10e-4"# Compare position values with tolerance (e.g.,{"position": "-300.0,-250.0"}) - name: ImprecisePositionjsonPath: ""param: "tolerance=0.01;separator=,"### Configuration Parameters Explained- **jsonPath**: Specifies the JSON path to which this rule applies (e.g., `$.user` targets the user object)- **extensible**: When `true`, allows the target JSON to contain additional fields not present in the expected JSON- **strictOrder**: When `true`, arrays must be in the exact same order; when `false`, array elements can be reordered- **ignoreNull**: When `true`, null values are ignored during comparison- **fastFail**: When `true`, comparison stops immediately when the first difference is found- **preProcess**: Pre-processing options for removing nodes before comparison- **customRules**: Array of custom comparison rules with specific behaviors:- **NumberPrecise**: Compares numbers with specified precision and rounding mode- **ArrayWithKey**: Compares arrays using a specific key field for element matching- **IngorePath**: Ignores specific JSON paths during comparison- **ArrayDisorder**: Allows array elements to be in any order- **ArrayRecursively**: Recursively compares array elements- **DegreePrecise**: Compares degree values with tolerance- **RadianPrecise**: Compares radian values with tolerance- **TolerantValue**: Compares values with tolerance for floating point differences- **PercentTolerant**: Compares values with percentage-based tolerance- **ImprecisePosition**: Compares position values with tolerance## Creating Custom Matcher ClassesUltraJSONDiff provides a flexible framework for creating custom matcher classes to handle specific comparison requirements. This section explains how to create and integrate custom matchers.### Matcher Interface TypesThere are three main interfaces you can implement for custom matchers: 1. **ValueMatcher<T>**: Basic interface for simple value comparison2. **CustomValueMatcher<T>**: Extended interface for complex comparison with detailed failure reporting3. **LocationAwareValueMatcher<T>**: Interface for matchers that need access to JSON path information### Basic Custom Matcher ExampleHere's an example of creating a simple custom matcher that compares date strings in a specific format: ```javapackage org.testtools.jsondiff.matcher;import org.testtools.jsondiff.CompareContext;import java.time.LocalDate;import java.time.format.DateTimeFormatter;/** * Custom matcher for comparing date strings in YYYY-MM-DD format */public class DateStringMatcher<T> implements ValueMatcher<T>{ private DateTimeFormatter formatter; public DateStringMatcher(){ this.formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd"); } @Override public boolean equal(T actual, T expected){ try{ String actualStr = actual.toString(); String expectedStr = expected.toString(); LocalDate actualDate = LocalDate.parse(actualStr, formatter); LocalDate expectedDate = LocalDate.parse(expectedStr, formatter); return actualDate.equals(expectedDate); } catch (Exception e){ // If parsing fails, fall back to string comparison return actual.equals(expected); } } @Override public void matcherInit(String param, CompareContext compareContext){ // Parse custom date format from parameter if provided if (param != null && !param.trim().isEmpty()){ try{ this.formatter = DateTimeFormatter.ofPattern(param.trim()); } catch (Exception e){ // Keep default format if parameter is invalid } } }}

- subRule: jsonPath: "$.dates"customRules: - name: DateStringjsonPath: "**.date"param: "yyyy-MM-dd" - name: RangePercentagejsonPath: "**.score"param: "tolerance=10.0"