Module io.cucumber.htmlformatter

Package io.cucumber.htmlformatter

Class MessagesToHtmlWriter

java.lang.Object

io.cucumber.htmlformatter.MessagesToHtmlWriter

All Implemented Interfaces:

AutoCloseable

public final class MessagesToHtmlWriter
extends Object
implements AutoCloseable

Writes the message output of a test run as single page html report.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MessagesToHtmlWriter.Builder
static interface	MessagesToHtmlWriter.Serializer	Serializes a message to JSON.

Method Summary

Modifier and Type	Method	Description
static MessagesToHtmlWriter.Builder	builder(MessagesToHtmlWriter.Serializer serializer)	Creates a builder to construct this writer.
void	close()	Closes the stream, flushing it first.
void	write(io.cucumber.messages.types.Envelope envelope)	Writes a cucumber message to the html output.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static MessagesToHtmlWriter.Builder builder(MessagesToHtmlWriter.Serializer serializer)

Creates a builder to construct this writer.

Parameters:

serializer - used to convert messages into json.

Returns:

a new builder

write

public void write(io.cucumber.messages.types.Envelope envelope)
           throws IOException

Writes a cucumber message to the html output.

Parameters:

envelope - the message

Throws:

IOException - if an IO error occurs

close

public void close()
           throws IOException

Closes the stream, flushing it first. Once closed further write() invocations will cause an IOException to be thrown. Closing a closed stream has no effect.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an IO error occurs