InternalMatcher (json-unit-core 2.9.0 API)

java.lang.Object
- net.javacrumbs.jsonunit.core.internal.matchers.InternalMatcher

```
public final class InternalMatcher
extends Object
```
Internal class, please do not use outside the library

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class InternalMatcher.ArrayMatcher
Array assertions

Nested Classes
Modifier and Type	Class and Description
`class`	`InternalMatcher.ArrayMatcher` Array assertions

Field Summary

Fields
Modifier and Type Field and Description

static String ACTUAL

Fields
Modifier and Type	Field and Description
`static String`	`ACTUAL`

Constructor Summary

Constructors
Constructor and Description

InternalMatcher(Object actual, Path path, String description, Configuration configuration)

Constructors
Constructor and Description
`InternalMatcher(Object actual, Path path, String description, Configuration configuration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`assertType(Node.NodeType type)`
`InternalMatcher`	`describedAs(String description)` Sets the description of this object.
`void`	`failOnType(Node node, String expectedType)`
`void`	`hasSameStructureAs(Object expected)` Compares JSON structure.
`void`	`isAbsent()` Fails if the node exists.
`InternalMatcher.ArrayMatcher`	`isArray()` Fails if the selected JSON is not an Array or is not present.
`void`	`isEqualTo(Object expected)`
`void`	`isNotEqualTo(Object expected)` Fails if compared documents are equal.
`void`	`isNotNull()`
`void`	`isNull()`
`void`	`isObject()` Fails if the selected JSON is not an Object or is not present.
`void`	`isPresent()` Fails if the node is missing.
`void`	`isPresent(String expectedValue)`
`void`	`isString()` Fails if the selected JSON is not a String or is not present.
`void`	`isStringEqualTo(String expected)` Fails if the selected JSON is not a String or is not present or the value is not equal to expected value.
`void`	`matches(org.hamcrest.Matcher<?> matcher)` Matches the node using Hamcrest matcher.
`InternalMatcher`	`node(String newPath)` Creates an assert object that only compares given node.
`InternalMatcher`	`whenIgnoringPaths(String... pathsToBeIgnored)`
`InternalMatcher`	`withDifferenceListener(DifferenceListener differenceListener)`
`InternalMatcher`	`withIgnorePlaceholder(String ignorePlaceholder)` Sets the placeholder that can be used to ignore values.
`InternalMatcher`	`withMatcher(String matcherName, org.hamcrest.Matcher<?> matcher)` Adds a internalMatcher to be used in ${json-unit.matches:matcherName} macro.
`InternalMatcher`	`withOptions(Option firstOption, Option... otherOptions)` Sets options changing comparison behavior.
`InternalMatcher`	`withTolerance(BigDecimal tolerance)` Sets the tolerance for floating number comparison.
`InternalMatcher`	`withTolerance(double tolerance)` Sets the tolerance for floating number comparison.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACTUAL
```
public static final String ACTUAL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InternalMatcher
```
public InternalMatcher(Object actual,
                       Path path,
                       String description,
                       Configuration configuration)
```
- Method Detail
  - whenIgnoringPaths
```
public InternalMatcher whenIgnoringPaths(String... pathsToBeIgnored)
```
  - describedAs
```
public InternalMatcher describedAs(String description)
```
    Sets the description of this object.
  - withIgnorePlaceholder
```
public InternalMatcher withIgnorePlaceholder(String ignorePlaceholder)
```
    Sets the placeholder that can be used to ignore values. The default value is ${json-unit.ignore}
  - withTolerance
```
public InternalMatcher withTolerance(double tolerance)
```
    Sets the tolerance for floating number comparison. If set to null, requires exact match of the values. For example, if set to 0.01, ignores all differences lower than 0.01, so 1 and 0.9999 are considered equal.
  - withTolerance
```
public InternalMatcher withTolerance(BigDecimal tolerance)
```
    Sets the tolerance for floating number comparison. If set to null, requires exact match of the values. For example, if set to 0.01, ignores all differences lower than 0.01, so 1 and 0.9999 are considered equal.
  - withMatcher
```
public InternalMatcher withMatcher(String matcherName,
                                   org.hamcrest.Matcher<?> matcher)
```
    Adds a internalMatcher to be used in ${json-unit.matches:matcherName} macro.
  - withDifferenceListener
```
public InternalMatcher withDifferenceListener(DifferenceListener differenceListener)
```
  - withOptions
```
public InternalMatcher withOptions(Option firstOption,
                                   Option... otherOptions)
```
    Sets options changing comparison behavior. This method has to be called before assertion. For more info see Option
    
    Parameters:
    
    firstOption -
    
    otherOptions -
    
    See Also:
    
    Option
  - isEqualTo
```
public void isEqualTo(Object expected)
```
  - isStringEqualTo
```
public void isStringEqualTo(String expected)
```
    Fails if the selected JSON is not a String or is not present or the value is not equal to expected value.
  - isNotEqualTo
```
public void isNotEqualTo(Object expected)
```
    Fails if compared documents are equal. The expected object is converted to JSON before comparison. Ignores order of sibling nodes and whitespaces.
    
    Parameters:
    
    expected -
  - hasSameStructureAs
```
public void hasSameStructureAs(Object expected)
```
    Compares JSON structure. Ignores values, only compares shape of the document and key names. Is too lenient, ignores types, prefer IGNORING_VALUES option instead.
    
    Parameters:
    
    expected -
  - node
```
public InternalMatcher node(String newPath)
```
    Creates an assert object that only compares given node. The path is denoted by JSON path, for example. assertThatJson("{\"root\":{\"test\":[1,2,3]}}").node("root.test[0]").isEqualTo("1");
    
    Parameters:
    
    newPath -
    
    Returns:
    
    object comparing only node given by path.
  - isAbsent
```
public void isAbsent()
```
    Fails if the node exists.
  - isPresent
```
public void isPresent()
```
    Fails if the node is missing.
  - isPresent
```
public void isPresent(String expectedValue)
```
  - isArray
```
public InternalMatcher.ArrayMatcher isArray()
```
    Fails if the selected JSON is not an Array or is not present.
    
    Returns:
  - assertType
```
public Node assertType(Node.NodeType type)
```
  - isObject
```
public void isObject()
```
    Fails if the selected JSON is not an Object or is not present.
  - isString
```
public void isString()
```
    Fails if the selected JSON is not a String or is not present.
  - isNull
```
public void isNull()
```
  - isNotNull
```
public void isNotNull()
```
  - failOnType
```
public void failOnType(Node node,
                       String expectedType)
```
  - matches
```
public void matches(org.hamcrest.Matcher<?> matcher)
```
    Matches the node using Hamcrest matcher.
    - Numbers are mapped to BigDecimal
    - Arrays are mapped to a Collection
    - Objects are mapped to a map so you can use json(Part)Equals or a Map matcher
    Parameters:
    
    matcher -

Class InternalMatcher

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTUAL

Constructor Detail

InternalMatcher

Method Detail

whenIgnoringPaths

describedAs

withIgnorePlaceholder

withTolerance

withTolerance

withMatcher

withDifferenceListener

withOptions

isEqualTo

isStringEqualTo

isNotEqualTo

hasSameStructureAs

node

isAbsent

isPresent

isPresent

isArray

assertType

isObject

isString

isNull

isNotNull

failOnType

matches