biz.aQute.bnd.reporter.plugins.entries.any

Class AnyEntryPlugin

java.lang.Object

biz.aQute.bnd.reporter.plugins.entries.any.AnyEntryPlugin

All Implemented Interfaces:

Plugin, ReportEntryPlugin<Object>

public class AnyEntryPlugin
extends Object
implements ReportEntryPlugin<Object>, Plugin

This plugin allows the user to define a report entry in a bnd property file. The user must provide the KEY_PROPERTY and the VALUE_PROPERTY properties to be effective. The KEY_PROPERTY will then be used as the entry name in the report.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PROPERTY
static String	VALUE_PROPERTY

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

ENTRY_NAME_PROPERTY, SOURCE_CLASS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AnyEntryPlugin()

Method Summary

Modifier and Type	Method and Description
Object	extract(Object source, 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

KEY_PROPERTY

public static final String KEY_PROPERTY

See Also:

Constant Field Values

VALUE_PROPERTY

public static final String VALUE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

AnyEntryPlugin

public AnyEntryPlugin()

Method Detail

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

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

extract

public Object extract(Object source,
                      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<Object>

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

public Map<String,String> getProperties()

Specified by:

getProperties in interface ReportEntryPlugin<Object>

Returns:

a map of properties, never null