Package aQute.bnd.maven.reporter.plugin.entries.mavenproject

Class CodeSnippetPlugin

java.lang.Object

aQute.bnd.maven.reporter.plugin.entries.mavenproject.CodeSnippetPlugin

All Implemented Interfaces:

aQute.bnd.service.Plugin, aQute.bnd.service.reporter.ReportEntryPlugin<MavenProjectWrapper>

public class CodeSnippetPlugin
extends Object
implements aQute.bnd.service.reporter.ReportEntryPlugin<MavenProjectWrapper>, aQute.bnd.service.Plugin

This plugin 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	Description
static final 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

Modifier and Type	Method	Description
List<biz.aQute.bnd.reporter.codesnippet.dto.CodeSnippetDTO>	extract(MavenProjectWrapper project, Locale locale)
Map<String,String>	getProperties()
void	setProperties(Map<String,String> map)
void	setReporter(aQute.service.reporter.Reporter processor)

Methods inherited from class java.lang.Object

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

Field Details

PATH_PROPERTY

public static final String PATH_PROPERTY

See Also:

• Constant Field Values

Constructor Details

CodeSnippetPlugin

public CodeSnippetPlugin()

Method Details

setReporter

public void setReporter(aQute.service.reporter.Reporter processor)

Specified by:

setReporter in interface aQute.bnd.service.Plugin

setProperties

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

Specified by:

setProperties in interface aQute.bnd.service.Plugin

Throws:

Exception

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface aQute.bnd.service.reporter.ReportEntryPlugin<MavenProjectWrapper>

extract

public List<biz.aQute.bnd.reporter.codesnippet.dto.CodeSnippetDTO> extract(MavenProjectWrapper project,
 Locale locale)
                                                                    throws Exception

Specified by:

extract in interface aQute.bnd.service.reporter.ReportEntryPlugin<MavenProjectWrapper>

Throws:

Exception