org.arquillian.reporter.api.builder.report

Interface ReportBuilder<BUILDERTYPE extends ReportBuilder,REPORTTYPE extends Report<REPORTTYPE,? extends ReportBuilder>>

Type Parameters:

BUILDERTYPE - The Builder type of this implementation itself

REPORTTYPE - The Report type the builder should build

All Superinterfaces:

Builder

All Known Subinterfaces:

BasicReportBuilder, ConfigurationReportBuilder, FailureReportBuilder, TestClassReportBuilder, TestMethodReportBuilder, TestSuiteReportBuilder

All Known Implementing Classes:

AbstractReportBuilder

public interface ReportBuilder<BUILDERTYPE extends ReportBuilder,REPORTTYPE extends Report<REPORTTYPE,? extends ReportBuilder>>
extends Builder

A Builder providing an API that helps you to build a Report

Author:

Matous Jobanek

Method Summary

Modifier and Type	Method and Description
BUILDERTYPE	addEntries(Collection<? extends Entry> entries) Adds the given collection of Entry-ies into the list of entries in the associated Report instance
BUILDERTYPE	addEntries(Entry... entries) Adds the given array Entry-ies into the list of entries in the associated Report instance
BUILDERTYPE	addEntries(String... entries) Adds the given array of strings into the list of entries in the associated Report instance.
BUILDERTYPE	addEntry(Entry entry) Adds the given Entry into the list of entries in the associated Report instance
BUILDERTYPE	addEntry(String entry) Adds the given string as a StringEntry into the list of entries in the associated Report instance
BUILDERTYPE	addKeyValueEntry(StringKey key, boolean value) Adds the given StringKey and boolean as a KeyValueEntry into the list of entries in the associated Report instance
BUILDERTYPE	addKeyValueEntry(StringKey key, Entry value) Adds the given StringKey and Entry as a KeyValueEntry into the list of entries in the associated Report instance
BUILDERTYPE	addKeyValueEntry(StringKey key, int value) Adds the given StringKey and integer value as a KeyValueEntry into the list of entries in the associated Report instance
BUILDERTYPE	addKeyValueEntry(StringKey key, String value) Adds the given StringKey and String value as a KeyValueEntry into the list of entries in the associated Report instance
BUILDERTYPE	addKeyValueEntry(String key, String value) Adds the given Strings as a KeyValueEntry into the list of entries in the associated Report instance
BUILDERTYPE	addReport(ReportBuilder reportBuilder) Takes the given ReportBuilder that represents a sub-report.
BUILDERTYPE	addReport(REPORTTYPE report) Adds the given Report into the list of sub-reports in the associated Report instance
REPORTTYPE	build() Finishes all necessary building actions and returns the resulting instance of Report.
BUILDERTYPE	feedKeyValueListFromMap(Map<String,String> keyValueMap) Takes the given map of Strings and each pair stores as a KeyValueEntry in the list of entries in the associated Report instance.
<SECTIONTYPE extends SectionEvent<SECTIONTYPE,REPORTTYPE,? extends SectionEvent>> ReportInSectionBuilder<REPORTTYPE,SECTIONTYPE>	inSection(SECTIONTYPE event) Builds the associated Report and assigns it into the given SectionEvent.

Method Detail

build

REPORTTYPE build()

Finishes all necessary building actions and returns the resulting instance of Report.

Returns:

A built instance of Report

addEntry

BUILDERTYPE addEntry(Entry entry)

Adds the given Entry into the list of entries in the associated Report instance

Parameters:

entry - An Entry to add

Returns:

The same instance of ReportBuilder with modified Report instance

addEntry

BUILDERTYPE addEntry(String entry)

Adds the given string as a StringEntry into the list of entries in the associated Report instance

Parameters:

entry - A string to be added as a StringEntry

Returns:

The same instance of ReportBuilder with modified Report instance

addEntries

BUILDERTYPE addEntries(Collection<? extends Entry> entries)

Adds the given collection of Entry-ies into the list of entries in the associated Report instance

Parameters:

entries - A collection of entry to be added

Returns:

The same instance of ReportBuilder with modified Report instance

addEntries

BUILDERTYPE addEntries(Entry... entries)

Adds the given array Entry-ies into the list of entries in the associated Report instance

Parameters:

entries - An array of entries to be added

Returns:

The same instance of ReportBuilder with modified Report instance

addEntries

BUILDERTYPE addEntries(String... entries)

Adds the given array of strings into the list of entries in the associated Report instance. Each string is stored as a StringEntry

Parameters:

entries - An array of strings to be added as StringEntry(-ies)

Returns:

The same instance of ReportBuilder with modified Report instance

feedKeyValueListFromMap

BUILDERTYPE feedKeyValueListFromMap(Map<String,String> keyValueMap)

Takes the given map of Strings and each pair stores as a KeyValueEntry in the list of entries in the associated Report instance. The String values are stored as UnknownStringKey.

Parameters:

keyValueMap - Map of Strings to be added as KeyValueEntry(-ies)

Returns:

The same instance of ReportBuilder with modified Report instance

addReport

BUILDERTYPE addReport(ReportBuilder reportBuilder)

Takes the given ReportBuilder that represents a sub-report. When the method this#build() is called, the builder is built as well and the resulting report is added into the list of sub-reports in the associated Report instance

Parameters:

reportBuilder - An Report to add into the list of sub-reports

Returns:

The same instance of ReportBuilder with modified Report instance

addReport

BUILDERTYPE addReport(REPORTTYPE report)

Adds the given Report into the list of sub-reports in the associated Report instance

Parameters:

report - An Report to add into the list of sub-reports

Returns:

The same instance of ReportBuilder with modified Report instance

addKeyValueEntry

BUILDERTYPE addKeyValueEntry(StringKey key,
                             Entry value)

Adds the given StringKey and Entry as a KeyValueEntry into the list of entries in the associated Report instance

Parameters:

key - A StringKey to be added as key of the KeyValueEntry

value - An Entry to be added as value of the KeyValueEntry

Returns:

The same instance of ReportBuilder with modified Report instance

addKeyValueEntry

BUILDERTYPE addKeyValueEntry(StringKey key,
                             String value)

Adds the given StringKey and String value as a KeyValueEntry into the list of entries in the associated Report instance

Parameters:

key - A StringKey to be added as key of the KeyValueEntry

value - A String to be added as value of the KeyValueEntry. It is stored as an UnknownStringKey

Returns:

The same instance of ReportBuilder with modified Report instance

addKeyValueEntry

BUILDERTYPE addKeyValueEntry(String key,
                             String value)

Adds the given Strings as a KeyValueEntry into the list of entries in the associated Report instance

Parameters:

key - A String to be added as key of the KeyValueEntry. It is stored as an UnknownStringKey

value - A String to be added as value of the KeyValueEntry. It is stored as an UnknownStringKey

Returns:

The same instance of ReportBuilder with modified Report instance

addKeyValueEntry

BUILDERTYPE addKeyValueEntry(StringKey key,
                             int value)

Adds the given StringKey and integer value as a KeyValueEntry into the list of entries in the associated Report instance

Parameters:

key - A StringKey to be added as key of the KeyValueEntry

value - An integer to be added as value of the KeyValueEntry. It is stored as an UnknownStringKey

Returns:

The same instance of ReportBuilder with modified Report instance

addKeyValueEntry

BUILDERTYPE addKeyValueEntry(StringKey key,
                             boolean value)

Adds the given StringKey and boolean as a KeyValueEntry into the list of entries in the associated Report instance

Parameters:

key - A StringKey to be added as key of the KeyValueEntry

value - A boolean to be added as value of the KeyValueEntry. It is stored as an UnknownStringKey

Returns:

The same instance of ReportBuilder with modified Report instance

inSection

<SECTIONTYPE extends SectionEvent<SECTIONTYPE,REPORTTYPE,? extends SectionEvent>> ReportInSectionBuilder<REPORTTYPE,SECTIONTYPE> inSection(SECTIONTYPE event)

Builds the associated Report and assigns it into the given SectionEvent. Then, it is possible to fire the event.

Type Parameters:

SECTIONTYPE - Type of the SectionEvent

Parameters:

event - A SectionEvent that should carry the built Report.

Returns:

An instance of ReportInSectionBuilder with the given SectionEvent containing the built Report.