xmlunit-placeholders : Org.XmlUnit.Placeholder Namespace

Overview

Signature

Remarks

Members

Member Details

PlaceholderDifferenceEvaluator Class

This class is used to add placeholder feature to XML comparison.

Syntax

public class PlaceholderDifferenceEvaluator

Remarks

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

Supported scenarios are demonstrated in the unit tests (PlaceholderDifferenceEvaluatorTest).

Default delimiters for placeholder are ${ and }. To use custom delimiters (in regular expression), create instance with the PlaceholderDifferenceEvaluator(string placeholderOpeningDelimiterRegex, string placeholderClosingDelimiterRegex) constructor.

since 2.6.0

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

Members

See Also: Inherited members from object.

Public Constructors

 Creates a PlaceholderDifferenceEvaluator with default delimiters PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX and PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX.
Creates a PlaceholderDifferenceEvaluator with default delimiters PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX and PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX.
Creates a PlaceholderDifferenceEvaluator with default delimiters PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX and PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX.

Public Fields

static readonly
PLACEHOLDER_DEFAULT_ARGS_CLOSING_DELIMITER_REGEX string . Documentation for this section has not yet been entered.
static readonly
PLACEHOLDER_DEFAULT_ARGS_OPENING_DELIMITER_REGEX string . Documentation for this section has not yet been entered.
static readonly
PLACEHOLDER_DEFAULT_ARGS_SEPARATOR_REGEX string . Documentation for this section has not yet been entered.
static readonly
PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX string . Documentation for this section has not yet been entered.
static readonly
PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX string . Documentation for this section has not yet been entered.

Public Methods

 Evaluate (Org.XmlUnit.Diff.Comparison, Org.XmlUnit.Diff.ComparisonResult) : Org.XmlUnit.Diff.ComparisonResult
DifferenceEvaluator using the configured PlaceholderHandlers.

Extension Methods

static
Singleton<T> (this T) : IEnumerable<T>
An enumerable containing a single element.

Member Details

PlaceholderDifferenceEvaluator Constructor

Creates a PlaceholderDifferenceEvaluator with default delimiters PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX and PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX.

Syntax

public PlaceholderDifferenceEvaluator ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PlaceholderDifferenceEvaluator Constructor

Creates a PlaceholderDifferenceEvaluator with default delimiters PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX and PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX.

Syntax

public PlaceholderDifferenceEvaluator (string placeholderOpeningDelimiterRegex, string placeholderClosingDelimiterRegex)

Parameters

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

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PlaceholderDifferenceEvaluator Constructor

Creates a PlaceholderDifferenceEvaluator with default delimiters PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX and PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX.

Syntax

public PlaceholderDifferenceEvaluator (string placeholderOpeningDelimiterRegex, string placeholderClosingDelimiterRegex, string placeholderArgsOpeningDelimiterRegex, string placeholderArgsClosingDelimiterRegex, string placeholderArgsSeparatorRegex)

Parameters

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

Remarks

since 2.8.0

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

Evaluate Method

DifferenceEvaluator using the configured PlaceholderHandlers.

Syntax

public Org.XmlUnit.Diff.ComparisonResult Evaluate (Org.XmlUnit.Diff.Comparison comparison, Org.XmlUnit.Diff.ComparisonResult outcome)

Parameters

comparison
Documentation for this section has not yet been entered.
outcome
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PLACEHOLDER_DEFAULT_ARGS_CLOSING_DELIMITER_REGEX Field

Documentation for this section has not yet been entered.

Syntax

public static readonly string PLACEHOLDER_DEFAULT_ARGS_CLOSING_DELIMITER_REGEX

Remarks

since 2.8.0

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PLACEHOLDER_DEFAULT_ARGS_OPENING_DELIMITER_REGEX Field

Documentation for this section has not yet been entered.

Syntax

public static readonly string PLACEHOLDER_DEFAULT_ARGS_OPENING_DELIMITER_REGEX

Remarks

since 2.8.0

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PLACEHOLDER_DEFAULT_ARGS_SEPARATOR_REGEX Field

Documentation for this section has not yet been entered.

Syntax

public static readonly string PLACEHOLDER_DEFAULT_ARGS_SEPARATOR_REGEX

Remarks

since 2.8.0

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX Field

Documentation for this section has not yet been entered.

Syntax

public static readonly string PLACEHOLDER_DEFAULT_CLOSING_DELIMITER_REGEX

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240

PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX Field

Documentation for this section has not yet been entered.

Syntax

public static readonly string PLACEHOLDER_DEFAULT_OPENING_DELIMITER_REGEX

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Org.XmlUnit.Placeholder
Assembly: xmlunit-placeholders (in xmlunit-placeholders.dll)
Assembly Versions: 2.9.2.240