Package net.javacrumbs.jsonunit.core

Class Configuration

java.lang.Object

net.javacrumbs.jsonunit.core.Configuration

public class Configuration
extends Object

Comparison configuration. Immutable.

Constructor Summary

Constructors

Constructor	Description
Configuration(BigDecimal tolerance, Options options, String ignorePlaceholder)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DifferenceListener	dummyDifferenceListener()
static Configuration	empty()	Returns an empty configuration.
DifferenceListener	getDifferenceListener()
String	getIgnorePlaceholder()
org.hamcrest.Matcher<?>	getMatcher(String matcherName)
Options	getOptions()
List<PathOption>	getPathOptions()
Set<String>	getPathsToBeIgnored()
BigDecimal	getTolerance()
boolean	shouldIgnore(String expectedValue)
Configuration	when(ConfigurationWhen.PathsParam object, ConfigurationWhen.ApplicableForPath... actions)	Defines general comparison options.
Configuration	when(Option first, Option... next)	Adds comparison options.
Configuration	whenIgnoringPaths(String... pathsToBeIgnored)	Makes JsonUnit ignore the specified paths in the actual value.
Configuration	whenIgnoringPaths(Collection<String> pathsToBeIgnored)
Configuration	withDifferenceListener(DifferenceListener differenceListener)	Sets difference listener
Configuration	withIgnorePlaceholder(String ignorePlaceholder)	Sets ignore placeholder.
Configuration	withMatcher(String matcherName, org.hamcrest.Matcher<?> matcher)	Adds a matcher to be used in ${json-unit.matches:matcherName} macro.
Configuration	withOptions(Options options)	Sets comparison options.
Configuration	withOptions(Option first, Option... next)	Adds comparison options.
Configuration	withPathOptions(List<PathOption> pathOptions)
Configuration	withTolerance(double tolerance)	Sets numerical comparison tolerance.
Configuration	withTolerance(BigDecimal tolerance)	Sets numerical comparison tolerance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

@Deprecated
public Configuration(BigDecimal tolerance,
                     Options options,
                     String ignorePlaceholder)

Deprecated.

Method Detail

empty

public static Configuration empty()

Returns an empty configuration.

Returns:

withTolerance

public Configuration withTolerance(BigDecimal tolerance)

Sets numerical comparison tolerance.

Parameters:

tolerance -

Returns:

withTolerance

public Configuration withTolerance(double tolerance)

Sets numerical comparison tolerance.

Parameters:

tolerance -

Returns:

when

public Configuration when(Option first,
                          Option... next)

Adds comparison options.

Parameters:

first -

next -

Returns:

withOptions

public Configuration withOptions(Option first,
                                 Option... next)

Adds comparison options.

Parameters:

first -

next -

Returns:

withOptions

public Configuration withOptions(Options options)

Sets comparison options.

Parameters:

options -

Returns:

when

public final Configuration when(ConfigurationWhen.PathsParam object,
                                ConfigurationWhen.ApplicableForPath... actions)

Defines general comparison options. See ConfigurationWhen.path(java.lang.String) for some examples.

Parameters:

object - an object to apply actions, e.g. ConfigurationWhen.path(java.lang.String), ConfigurationWhen.rootPath().

actions - actions to be applied on the object.

See Also:

ConfigurationWhen.path(java.lang.String)

withPathOptions

public Configuration withPathOptions(List<PathOption> pathOptions)

whenIgnoringPaths

public Configuration whenIgnoringPaths(Collection<String> pathsToBeIgnored)

whenIgnoringPaths

public Configuration whenIgnoringPaths(String... pathsToBeIgnored)

Makes JsonUnit ignore the specified paths in the actual value. If the path matches, it's completely ignored. It may be missing, null or have any value

Parameters:

pathsToBeIgnored -

Returns:

See Also:

ConfigurationWhen.thenIgnore()

withIgnorePlaceholder

public Configuration withIgnorePlaceholder(String ignorePlaceholder)

Sets ignore placeholder.

Parameters:

ignorePlaceholder -

Returns:

withMatcher

public Configuration withMatcher(String matcherName,
                                 org.hamcrest.Matcher<?> matcher)

Adds a matcher to be used in ${json-unit.matches:matcherName} macro.

Parameters:

matcherName -

matcher -

Returns:

withDifferenceListener

public Configuration withDifferenceListener(DifferenceListener differenceListener)

Sets difference listener

dummyDifferenceListener

public static DifferenceListener dummyDifferenceListener()

getMatcher

public org.hamcrest.Matcher<?> getMatcher(String matcherName)

getTolerance

public BigDecimal getTolerance()

getOptions

public Options getOptions()

getIgnorePlaceholder

public String getIgnorePlaceholder()

getPathOptions

public List<PathOption> getPathOptions()

getPathsToBeIgnored

public Set<String> getPathsToBeIgnored()

getDifferenceListener

public DifferenceListener getDifferenceListener()

shouldIgnore

public boolean shouldIgnore(String expectedValue)