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

Configuration

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

Deprecated.

Method Details

empty

@NotNull public static @NotNull Configuration empty()

Returns an empty configuration.

withTolerance

@NotNull public @NotNull Configuration withTolerance(@Nullable @Nullable BigDecimal tolerance)

Sets numerical comparison tolerance.

Parameters:

tolerance -

Returns:

withTolerance

@NotNull public @NotNull Configuration withTolerance(double tolerance)

Sets numerical comparison tolerance.

Parameters:

tolerance -

Returns:

when

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

Adds comparison options.

Parameters:

first -

next -

Returns:

withOptions

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

Adds comparison options.

Parameters:

first -

next -

Returns:

withOptions

@NotNull public @NotNull Configuration withOptions(@NotNull @NotNull Options options)

Sets comparison options.

Parameters:

options -

Returns:

when

@NotNull public final @NotNull Configuration when(@NotNull @NotNull ConfigurationWhen.PathsParam object, @NotNull @NotNull 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

@NotNull public @NotNull Configuration withPathOptions(@NotNull @NotNull List<PathOption> pathOptions)

whenIgnoringPaths

@NotNull public @NotNull Configuration whenIgnoringPaths(@NotNull @NotNull Collection<String> pathsToBeIgnored)

whenIgnoringPaths

@NotNull public @NotNull Configuration whenIgnoringPaths(@NotNull @NotNull 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

@NotNull public @NotNull Configuration withIgnorePlaceholder(@NotNull @NotNull String ignorePlaceholder)

Sets ignore placeholder.

Parameters:

ignorePlaceholder -

Returns:

withMatcher

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

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

Parameters:

matcherName -

matcher -

Returns:

withDifferenceListener

@NotNull public @NotNull Configuration withDifferenceListener(@NotNull @NotNull DifferenceListener differenceListener)

Sets difference listener

dummyDifferenceListener

@NotNull public static @NotNull DifferenceListener dummyDifferenceListener()

getMatcher

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

getTolerance

@Nullable public @Nullable BigDecimal getTolerance()

getOptions

@NotNull public @NotNull Options getOptions()

getIgnorePlaceholder

@NotNull public @NotNull String getIgnorePlaceholder()

getPathOptions

@NotNull public @NotNull List<PathOption> getPathOptions()

getPathsToBeIgnored

@NotNull public @NotNull Set<String> getPathsToBeIgnored()

getDifferenceListener

@NotNull public @NotNull DifferenceListener getDifferenceListener()

shouldIgnore

public boolean shouldIgnore(String expectedValue)