biz.aQute.bnd.reporter.plugins.entries.bndworkspace

Class BndWorkspaceContentsPlugin

java.lang.Object

biz.aQute.bnd.reporter.plugins.entries.bndworkspace.BndWorkspaceContentsPlugin

All Implemented Interfaces:

Plugin, ReportEntryPlugin<Workspace>

public class BndWorkspaceContentsPlugin
extends Object
implements ReportEntryPlugin<Workspace>, Plugin

This plugins allows to extract all the bnd projects built by a bnd workspace. The user can set the EXCLUDES_PROPERTY to skip some projects and the USE_CONFIG_PROPERTY to the desired configuration name that will be used to generate the report of the projects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCLUDES_PROPERTY
static String	USE_CONFIG_PROPERTY

Fields inherited from interface aQute.bnd.service.reporter.ReportEntryPlugin

ENTRY_NAME_PROPERTY, SOURCE_CLASS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
BndWorkspaceContentsPlugin()

Method Summary

Modifier and Type	Method and Description
Object	extract(Workspace workspace, Locale locale) Extracts a piece of information from the source in arguments.
Map<String,String>	getProperties()
void	setProperties(Map<String,String> map) Give the plugin the remaining properties.
void	setReporter(Reporter processor) Set the current reporter.

Methods inherited from class java.lang.Object

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

Field Detail

USE_CONFIG_PROPERTY

public static final String USE_CONFIG_PROPERTY

See Also:

Constant Field Values

EXCLUDES_PROPERTY

public static final String EXCLUDES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

BndWorkspaceContentsPlugin

public BndWorkspaceContentsPlugin()

Method Detail

setReporter

public void setReporter(Reporter processor)

Description copied from interface: Plugin

Set the current reporter. This is called at init time. This plugin should report all errors and warnings to this reporter.

Specified by:

setReporter in interface Plugin

setProperties

public void setProperties(Map<String,String> map)
                   throws Exception

Description copied from interface: Plugin

Give the plugin the remaining properties. When a plugin is declared, the clause can contain extra properties. All the properties and directives are given to the plugin to use.

Specified by:

setProperties in interface Plugin

Parameters:

map - attributes and directives for this plugin's clause

Throws:

Exception

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface ReportEntryPlugin<Workspace>

Returns:

a map of properties, never null

extract

public Object extract(Workspace workspace,
                      Locale locale)
               throws Exception

Description copied from interface: ReportEntryPlugin

Extracts a piece of information from the source in arguments.

If the source contains localized data, it will be extracted for the specified locale or a less specific if not found.

Specified by:

extract in interface ReportEntryPlugin<Workspace>

Parameters:

workspace - the source to inspect, must not be null

locale - the String representation of a Locale, must not be null

Returns:

a DTO representation or null if no data is available

Throws:

Exception