Module de.skuzzle.test.snapshots.xml.jaxb

Package de.skuzzle.test.snapshots.data.xml

Class XmlSnapshot

java.lang.Object

de.skuzzle.test.snapshots.data.xml.XmlSnapshot

All Implemented Interfaces:

StructuredDataProvider

@API(status=STABLE)
public final class XmlSnapshot
extends Object
implements StructuredDataProvider

StructuredData builder for serializing test results to XML, relying on JAXB and XML-Unit.

You can either use a pre-configured default instance via xml or use any of the static factory methods to customize the construction.

Author:

Simon Taddiken

Field Summary

Fields

Modifier and Type	Field	Description
static StructuredDataProvider	xml	Simple default StructuredData instance which infers the JAXB context from a test's actual result object.

Method Summary

Modifier and Type	Method	Description
StructuredData	build()
XmlSnapshot	compareUsing(Consumer<org.xmlunit.assertj.CompareAssert> xmls)	Defines which Xml-Assert assertion method will actually be used.
static XmlSnapshot	inferJaxbContext()	Tries to infer the JAXBContext from the passed in actual test result.
static XmlSnapshot	with(javax.xml.bind.JAXBContext jaxbContext)	Uses the given JAXBContext as entry point for serializing snapshots.
XmlSnapshot	withMarshaller(de.skuzzle.test.snapshots.data.xml.XmlSnapshot.MarshallerSupplier marshallerSupplier)	Supplies the Marshaller which will be used to serialize the snapshot to xml.

Methods inherited from class java.lang.Object

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

Field Detail

xml

public static final StructuredDataProvider xml

Simple default StructuredData instance which infers the JAXB context from a test's actual result object.

If you need control over how the JAXBContext and the Marshaller are being set up, use the static factory methods in XmlSnapshot instead of this static constant.

See Also:

with(JAXBContext), inferJaxbContext()

Method Detail

inferJaxbContext

public static XmlSnapshot inferJaxbContext()

Tries to infer the JAXBContext from the passed in actual test result.

Returns:

A builder for building StructuredData.

with

public static XmlSnapshot with(javax.xml.bind.JAXBContext jaxbContext)

Uses the given JAXBContext as entry point for serializing snapshots.

Parameters:

jaxbContext - The JAXBContext to use.

Returns:

A builder for building StructuredData.

withMarshaller

public XmlSnapshot withMarshaller(de.skuzzle.test.snapshots.data.xml.XmlSnapshot.MarshallerSupplier marshallerSupplier)

Supplies the Marshaller which will be used to serialize the snapshot to xml.

Parameters:

marshallerSupplier - The supplier.

Returns:

This builder instance.

compareUsing

@API(status=EXPERIMENTAL)
public XmlSnapshot compareUsing(Consumer<org.xmlunit.assertj.CompareAssert> xmls)

Defines which Xml-Assert assertion method will actually be used. Defaults to CompareAssert.areIdentical().

Parameters:

xmls - Consumes the CompareAssert which compares the actual and expected xml.

Returns:

This builder instance.

build

public StructuredData build()

Specified by:

build in interface StructuredDataProvider