Package org.xmlunit.placeholder

Class PlaceholderSupport

java.lang.Object

org.xmlunit.placeholder.PlaceholderSupport

public class PlaceholderSupport
extends Object

Adds support for the placeholder feature to a DifferenceEngineConfigurer - like DiffBuilder or org.xmlunit.matchers.CompareMatcher.

This class and the whole module are considered experimental and any API may change between releases of XMLUnit.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
static <D extends DifferenceEngineConfigurer<D>> D	withPlaceholderSupport(D configurer)	Adds placeholder support to a DifferenceEngineConfigurer.
static <D extends DifferenceEngineConfigurer<D>> D	withPlaceholderSupportChainedAfter(D configurer, DifferenceEvaluator evaluator)	Adds placeholder support to a DifferenceEngineConfigurer considering an additional DifferenceEvaluator.
static <D extends DifferenceEngineConfigurer<D>> D	withPlaceholderSupportUsingDelimiters(D configurer, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex)	Adds placeholder support to a DifferenceEngineConfigurer.
static <D extends DifferenceEngineConfigurer<D>> D	withPlaceholderSupportUsingDelimiters(D configurer, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, String placeholderArgsOpeningDelimiterRegex, String placeholderArgsClosingDelimiterRegex, String placeholderArgsSeparatorRegex)	Adds placeholder support to a DifferenceEngineConfigurer.
static <D extends DifferenceEngineConfigurer<D>> D	withPlaceholderSupportUsingDelimitersChainedAfter(D configurer, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, String placeholderArgsOpeningDelimiterRegex, String placeholderArgsClosingDelimiterRegex, String placeholderArgsSeparatorRegex, DifferenceEvaluator evaluator)	Adds placeholder support to a DifferenceEngineConfigurer considering an additional DifferenceEvaluator.
static <D extends DifferenceEngineConfigurer<D>> D	withPlaceholderSupportUsingDelimitersChainedAfter(D configurer, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, DifferenceEvaluator evaluator)	Adds placeholder support to a DifferenceEngineConfigurer considering an additional DifferenceEvaluator.

Methods inherited from class java.lang.Object

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

Method Details

withPlaceholderSupport

public static <D extends DifferenceEngineConfigurer<D>>
D withPlaceholderSupport(D configurer)

Adds placeholder support to a DifferenceEngineConfigurer.

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Type Parameters:

D - type of configurer

Parameters:

configurer - the configurer to add support to

Returns:

the configurer with placeholder support added in

withPlaceholderSupportUsingDelimiters

public static <D extends DifferenceEngineConfigurer<D>>
D withPlaceholderSupportUsingDelimiters(D configurer,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex)

Adds placeholder support to a DifferenceEngineConfigurer.

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Type Parameters:

D - type of configurer

Parameters:

configurer - the configurer to add support to

placeholderOpeningDelimiterRegex - regular expression for the opening delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX if the parameter is null or blank

placeholderClosingDelimiterRegex - regular expression for the closing delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX if the parameter is null or blank

Returns:

the configurer with placeholder support added in

withPlaceholderSupportUsingDelimiters

public static <D extends DifferenceEngineConfigurer<D>>
D withPlaceholderSupportUsingDelimiters(D configurer,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex,
 String placeholderArgsOpeningDelimiterRegex,
 String placeholderArgsClosingDelimiterRegex,
 String placeholderArgsSeparatorRegex)

Adds placeholder support to a DifferenceEngineConfigurer.

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Type Parameters:

D - type of configurer

Parameters:

configurer - the configurer to add support to

placeholderOpeningDelimiterRegex - regular expression for the opening delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX if the parameter is null or blank

placeholderClosingDelimiterRegex - regular expression for the closing delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX if the parameter is null or blank

placeholderArgsOpeningDelimiterRegex - regular expression for the opening delimiter of the placeholder's argument list, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_ARGS_OPENING_DELIMITER_REGEX if the parameter is null or blank

placeholderArgsClosingDelimiterRegex - regular expression for the closing delimiter of the placeholder's argument list, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_ARGS_CLOSING_DELIMITER_REGEX if the parameter is null or blank

placeholderArgsSeparatorRegex - regular expression for the delimiter between arguments inside of the placeholder's argument list, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_ARGS_SEPARATOR_REGEX if the parameter is null or blank

Returns:

the configurer with placeholder support added in

Since:

2.7.0

withPlaceholderSupportChainedAfter

public static <D extends DifferenceEngineConfigurer<D>>
D withPlaceholderSupportChainedAfter(D configurer,
 DifferenceEvaluator evaluator)

Adds placeholder support to a DifferenceEngineConfigurer considering an additional DifferenceEvaluator.

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Type Parameters:

D - type of configurer

Parameters:

configurer - the configurer to add support to

evaluator - the additional evaluator - placeholder support is chained after the given evaluator

Returns:

the configurer with placeholder support added in

withPlaceholderSupportUsingDelimitersChainedAfter

public static <D extends DifferenceEngineConfigurer<D>>
D withPlaceholderSupportUsingDelimitersChainedAfter(D configurer,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex,
 DifferenceEvaluator evaluator)

Adds placeholder support to a DifferenceEngineConfigurer considering an additional DifferenceEvaluator.

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Type Parameters:

D - type of configurer

Parameters:

configurer - the configurer to add support to

placeholderOpeningDelimiterRegex - regular expression for the opening delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX if the parameter is null or blank

placeholderClosingDelimiterRegex - regular expression for the closing delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX if the parameter is null or blank

evaluator - the additional evaluator - placeholder support is chained after the given evaluator

Returns:

the configurer with placeholder support added in

withPlaceholderSupportUsingDelimitersChainedAfter

public static <D extends DifferenceEngineConfigurer<D>>
D withPlaceholderSupportUsingDelimitersChainedAfter(D configurer,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex,
 String placeholderArgsOpeningDelimiterRegex,
 String placeholderArgsClosingDelimiterRegex,
 String placeholderArgsSeparatorRegex,
 DifferenceEvaluator evaluator)

Adds placeholder support to a DifferenceEngineConfigurer considering an additional DifferenceEvaluator.

This overwrites any DifferenceEvaluator set via earlier invocations of withDifferenceEvaluator.

Type Parameters:

D - type of configurer

Parameters:

configurer - the configurer to add support to

placeholderOpeningDelimiterRegex - regular expression for the opening delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX if the parameter is null or blank

placeholderClosingDelimiterRegex - regular expression for the closing delimiter of placeholder, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX if the parameter is null or blank

evaluator - the additional evaluator - placeholder support is chained after the given evaluator

placeholderArgsOpeningDelimiterRegex - regular expression for the opening delimiter of the placeholder's argument list, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_ARGS_OPENING_DELIMITER_REGEX if the parameter is null or blank

placeholderArgsClosingDelimiterRegex - regular expression for the closing delimiter of the placeholder's argument list, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_ARGS_CLOSING_DELIMITER_REGEX if the parameter is null or blank

placeholderArgsSeparatorRegex - regular expression for the delimiter between arguments inside of the placeholder's argument list, defaults to PlaceholderDifferenceEvaluator.PLACEHOLDER_DEFAULT_ARGS_SEPARATOR_REGEX if the parameter is null or blank

Returns:

the configurer with placeholder support added in