biz.aQute.bnd.reporter.plugins.entries.bndproject

Class CodeSnippetPlugin

java.lang.Object

biz.aQute.bnd.reporter.plugins.entries.bndproject.CodeSnippetPlugin

All Implemented Interfaces:

Plugin, ReportEntryPlugin<Project>

public class CodeSnippetPlugin
extends Object
implements ReportEntryPlugin<Project>, Plugin

This plugins allows to extract code snippets from a project. The user can set the PATH_PROPERTY to specify the folder from which snippets are looked up. By default, snippets are read from {testClasspath}/examples directory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_PROPERTY

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

ENTRY_NAME_PROPERTY, SOURCE_CLASS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CodeSnippetPlugin()

Method Summary

Modifier and Type	Method and Description
List<CodeSnippetDTO>	extract(Project project, 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

PATH_PROPERTY

public static final String PATH_PROPERTY

See Also:

Constant Field Values

Constructor Detail

CodeSnippetPlugin

public CodeSnippetPlugin()

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

Returns:

a map of properties, never null

extract

public List<CodeSnippetDTO> extract(Project project,
                                    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<Project>

Parameters:

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