biz.aQute.bnd.reporter.generator

Class ReportGeneratorBuilder

java.lang.Object

biz.aQute.bnd.reporter.generator.ReportGeneratorBuilder

public class ReportGeneratorBuilder
extends Object

Build the ReportGeneratorService.

Method Summary

Modifier and Type	Method and Description
ReportGeneratorBuilder	addPlugin(String classNameOrPluginName) Add a plugin to be used as default plugins for custom configuration or in addition to plugins defined by the processor.
ReportGeneratorService	build() Build the service.
static ReportGeneratorBuilder	create() Create a new builder.
ReportGeneratorBuilder	registerPlugin(String className) Register a plugin to be used by the ReportGeneratorConstants.REPORT_CONFIG_INSTRUCTION and to be able to use plugin short names.
ReportGeneratorBuilder	setProcessor(Processor processor) Set the processor from which plugins are loaded as well as properties and to which errors are reported.
ReportGeneratorBuilder	useCustomConfig() If set, the ReportGeneratorConstants.REPORT_CONFIG_INSTRUCTION instruction will be processed to customize the report generation.
ReportGeneratorBuilder	withAggregatorProjectDefaultPlugins() Add the default plugins used to extract aggregator project or workspace data.
ReportGeneratorBuilder	withBundleDefaultPlugins() Add the default plugins used to extract bundle data.
ReportGeneratorBuilder	withProjectDefaultPlugins() Add the default plugins used to extract project data.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ReportGeneratorBuilder create()

Create a new builder.

Returns:

the builder

setProcessor

public ReportGeneratorBuilder setProcessor(Processor processor)

Set the processor from which plugins are loaded as well as properties and to which errors are reported.

Parameters:

processor - the processor to use.

Returns:

the builder

useCustomConfig

public ReportGeneratorBuilder useCustomConfig()

If set, the ReportGeneratorConstants.REPORT_CONFIG_INSTRUCTION instruction will be processed to customize the report generation.

Returns:

the builder

registerPlugin

public ReportGeneratorBuilder registerPlugin(String className)

Register a plugin to be used by the ReportGeneratorConstants.REPORT_CONFIG_INSTRUCTION and to be able to use plugin short names.

Parameters:

className - the class name of the plugin.

Returns:

the builder

addPlugin

public ReportGeneratorBuilder addPlugin(String classNameOrPluginName)

Add a plugin to be used as default plugins for custom configuration or in addition to plugins defined by the processor.

Parameters:

classNameOrPluginName - a class name or the short name of a plugin.

Returns:

the builder

withBundleDefaultPlugins

public ReportGeneratorBuilder withBundleDefaultPlugins()

Add the default plugins used to extract bundle data.

Returns:

the builder

withProjectDefaultPlugins

public ReportGeneratorBuilder withProjectDefaultPlugins()

Add the default plugins used to extract project data.

Returns:

the builder

withAggregatorProjectDefaultPlugins

public ReportGeneratorBuilder withAggregatorProjectDefaultPlugins()

Add the default plugins used to extract aggregator project or workspace data.

Returns:

the builder

build

public ReportGeneratorService build()

Build the service.

Returns:

the service