Class CodeSnippetPlugin
- java.lang.Object
-
- biz.aQute.bnd.reporter.plugins.entries.bndproject.CodeSnippetPlugin
-
- All Implemented Interfaces:
Plugin
,ReportEntryPlugin<Project>
public class CodeSnippetPlugin extends java.lang.Object implements ReportEntryPlugin<Project>, Plugin
This plugins allows to extract code snippets from a project. The user can set thePATH_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 Description private CodeSnippetExtractor
_extractor
private java.util.Map<java.lang.String,java.lang.String>
_properties
static java.lang.String
PATH_PROPERTY
-
Fields inherited from interface aQute.bnd.service.reporter.ReportEntryPlugin
ENTRY_NAME_PROPERTY, SOURCE_CLASS_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description CodeSnippetPlugin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<CodeSnippetDTO>
extract(Project project, java.util.Locale locale)
Extracts a piece of information from the source in arguments.private java.io.File
getDirectory(Project p)
java.util.Map<java.lang.String,java.lang.String>
getProperties()
void
setProperties(java.util.Map<java.lang.String,java.lang.String> map)
Give the plugin the remaining properties.void
setReporter(Reporter processor)
Set the current reporter.
-
-
-
Field Detail
-
PATH_PROPERTY
public static final java.lang.String PATH_PROPERTY
- See Also:
- Constant Field Values
-
_properties
private final java.util.Map<java.lang.String,java.lang.String> _properties
-
_extractor
private final CodeSnippetExtractor _extractor
-
-
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 interfacePlugin
-
setProperties
public void setProperties(java.util.Map<java.lang.String,java.lang.String> map) throws java.lang.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 interfacePlugin
- Parameters:
map
- attributes and directives for this plugin's clause- Throws:
java.lang.Exception
-
getProperties
public java.util.Map<java.lang.String,java.lang.String> getProperties()
- Specified by:
getProperties
in interfaceReportEntryPlugin<Project>
- Returns:
- a map of properties, never
null
-
getDirectory
private java.io.File getDirectory(Project p)
-
extract
public java.util.List<CodeSnippetDTO> extract(Project project, java.util.Locale locale) throws java.lang.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 interfaceReportEntryPlugin<Project>
- Parameters:
project
- the source to inspect, must not benull
locale
- theString
representation of aLocale
, must not benull
- Returns:
- a DTO representation or
null
if no data is available - Throws:
java.lang.Exception
-
-