Package org.opentest4j.reporting.tooling.spi.htmlreport

Interface Section

@Immutable
@API(status=EXPERIMENTAL,
     since="0.2.0")
public interface Section

A titled section to be rendered in the HTML report.

Since:

0.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Section.Builder	Builder for Section.

Method Summary

Modifier and Type	Method	Description
static Section.Builder	builder()	Returns a new builder for Section.
List<Block<?>>	getBlocks()	Returns the blocks in this section.
Optional<String>	getMetaInfo()	Returns the meta information of this section.
default int	getOrder()	Returns the order of this section.
String	getTitle()	Returns the title of this section.

Method Details

builder

static Section.Builder builder()

Returns a new builder for Section.

Returns:

a new builder for Section

getTitle

String getTitle()

Returns the title of this section.

Returns:

the title of this section

getMetaInfo

Optional<String> getMetaInfo()

Returns the meta information of this section.

This may, for example, contain a timestamp.

Returns:

the meta information of this section

getBlocks

List<Block<?>> getBlocks()

Returns the blocks in this section.

Returns:

the blocks in this section

getOrder

@Default
default int getOrder()

Returns the order of this section.

This is used to sort the all contributed sections in the HTML report.

Returns:

the order of this section