aQute.bnd.service.reporter

Interface ReportEntryPlugin<T>

All Known Implementing Classes:

AnyEntryPlugin, BndProjectContentsPlugin, BndWorkspaceContentsPlugin, CodeSnippetPlugin, CommonInfoPlugin, CommonInfoProjectPlugin, ComponentsPlugin, FileNamePlugin, ImportJarResourcePlugin, ImportResourcePlugin, ManifestPlugin, MavenCoordinatePlugin, MetatypesPlugin

@ProviderType
public interface ReportEntryPlugin<T>

This plugin extracts a piece of information (potentially localized) from a source object and converts it into a DTO representation.

The ReportGeneratorService will select a collection of those plugins and apply them on a source object. Each result will be put into a Map under the corresponding ENTRY_NAME_PROPERTY property value. This final Map will constitute a report of the source object. Plugins will be selected thanks to their SOURCE_CLASS_PROPERTY and optionally by any provided properties.

Implementers: Implementers must define the ENTRY_NAME_PROPERTY and the SOURCE_CLASS_PROPERTY

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTRY_NAME_PROPERTY The entry name property under which the DTO value extracted by the extract(Object, Locale) method is added to a report.
static String	SOURCE_CLASS_PROPERTY The class name of the source object that a ReportEntryPlugin can extract.

Method Summary

Modifier and Type	Method and Description
Object	extract(T source, Locale locale) Extracts a piece of information from the source in arguments.
Map<String,String>	getProperties()

Field Detail

ENTRY_NAME_PROPERTY

static final String ENTRY_NAME_PROPERTY

The entry name property under which the DTO value extracted by the extract(Object, Locale) method is added to a report.

See Also:

Constant Field Values

SOURCE_CLASS_PROPERTY

static final String SOURCE_CLASS_PROPERTY

The class name of the source object that a ReportEntryPlugin can extract.

See Also:

Constant Field Values

Method Detail

extract

Object extract(T source,
               Locale locale)
        throws Exception

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.

Parameters:

source - 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

getProperties

Map<String,String> getProperties()

Returns:

a map of properties, never null