io.qameta.allure.core

Interface Configuration

public interface Configuration

Report configuration.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
java.util.List<Aggregator>	getAggregators() Returns all configured aggregators.
<T> java.util.Optional<T>	getContext(java.lang.Class<T> contextType) Resolve context by given type.
java.util.List<Plugin>	getPlugins() Returns all configured plugins.
java.util.List<Reader>	getReaders() Returns all configured readers.
java.util.List<Widget>	getWidgets() Returns all configured widgets.
default <T> T	requireContext(java.lang.Class<T> contextType) The same as getContext(Class) but throws an exception if context doesn't present.

Method Detail

getPlugins

java.util.List<Plugin> getPlugins()

Returns all configured plugins.

Returns:

configured plugins.

getAggregators

java.util.List<Aggregator> getAggregators()

Returns all configured aggregators.

Returns:

configured aggregators.

getReaders

java.util.List<Reader> getReaders()

Returns all configured readers.

Returns:

configured readers.

getWidgets

java.util.List<Widget> getWidgets()

Returns all configured widgets.

Returns:

configured widgets.

getContext

<T> java.util.Optional<T> getContext(java.lang.Class<T> contextType)

Resolve context by given type.

Type Parameters:

T - the java type of context.

Parameters:

contextType - type of context to resolve.

Returns:

resolved context.

requireContext

default <T> T requireContext(java.lang.Class<T> contextType)

The same as getContext(Class) but throws an exception if context doesn't present.

Returns:

resolved context.

Throws:

ContextNotFoundException - if no such context present.