Top Description Fields Constructors Methods
org.opentest4j.reporting.events.root

public Class Events

extends Element<Events>
Class Inheritance
Annotations
@API
status:EXPERIMENTAL
since:0.1.0
Imports
org.apiguardian.api.API, org.opentest4j.reporting.events.api.Context, .DocumentWriter, .Element, .NamespaceRegistry, org.opentest4j.reporting.schema.Namespace, .QualifiedName, java.nio.file.Path

The events element of the events namespace.
Since
0.1.0

Field Summary

Modifier and TypeField and Description
public static final QualifiedName
ELEMENT

Qualified name of the events element.

Constructor Summary

AccessConstructor and Description
private
Events(Context context)

Method Summary

Modifier and TypeMethod and Description
public static DocumentWriter<Events>

Returns:

the new DocumentWriter
createDocumentWriter
(NamespaceRegistry
the namespace registry to use
namespaceRegistry
,
Path
the file to write to
xmlFile
)

Create a new DocumentWriter for the event-based reporting format.

Inherited from org.opentest4j.reporting.events.api.Element:
appendtoStringwithAttributewithCDataSectionwithContent

Field Detail

ELEMENTback to summary
public static final QualifiedName ELEMENT

Qualified name of the events element.

Constructor Detail

Eventsback to summary
private Events(Context context)

Method Detail

createDocumentWriterback to summary
public static DocumentWriter<Events> createDocumentWriter(NamespaceRegistry namespaceRegistry, Path xmlFile) throws Exception

Create a new DocumentWriter for the event-based reporting format.

Parameters
namespaceRegistry:NamespaceRegistry

the namespace registry to use

xmlFile:Path

the file to write to

Returns:DocumentWriter<Events>

the new DocumentWriter

Exceptions
Exception:
if an error initializing the XML writing infrastructure or writing to the XML file occurs