Package org.apache.felix.bundleplugin.baseline

Class BaselineReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.felix.bundleplugin.baseline.AbstractBaselinePlugin

org.apache.felix.bundleplugin.baseline.BaselineReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

@Mojo(name="baseline-report",
      threadSafe=true,
      defaultPhase=SITE)
public final class BaselineReport
extends AbstractBaselinePlugin
implements org.apache.maven.reporting.MavenReport

BND Baseline report.

Since:

2.4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	BaselineReport.Context

Field Summary

Fields

Modifier and Type	Field	Description
private File	outputDirectory	Specifies the directory where the report will be generated.

Fields inherited from class org.apache.felix.bundleplugin.baseline.AbstractBaselinePlugin

buildContext, comparisonArtifactId, comparisonClassifier, comparisonGroupId, comparisonPackaging, comparisonVersion, factory, failOnError, failOnWarning, project, resolver, session, skip, supportedProjectTypes

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
BaselineReport()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected void	close(Object context)
protected void	endBaseline(Object context)
protected void	endDiff(Object context, int depth)
protected void	endPackage(Object context)
void	generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)
private ResourceBundle	getBundle(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
protected Object	init(Object context)
boolean	isExternalReport()
void	setReportOutputDirectory(File outputDirectory)
protected void	startBaseline(Object context, String generationDate, String bundleName, String currentVersion, String previousVersion)
protected void	startDiff(Object context, int depth, String type, String name, String delta, String shortDelta)
protected void	startPackage(Object context, boolean mismatch, String packageName, String shortDelta, String delta, aQute.bnd.version.Version newerVersion, aQute.bnd.version.Version olderVersion, aQute.bnd.version.Version suggestedVersion, DiffMessage diffMessage, Map<String,String> attributes)

Methods inherited from class org.apache.felix.bundleplugin.baseline.AbstractBaselinePlugin

execute, execute

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}")
private File outputDirectory

Specifies the directory where the report will be generated.

Constructor Details

BaselineReport

public BaselineReport()

Method Details

init

protected Object init(Object context)

Specified by:

init in class AbstractBaselinePlugin

close

protected void close(Object context)

Specified by:

close in class AbstractBaselinePlugin

startBaseline

protected void startBaseline(Object context,
 String generationDate,
 String bundleName,
 String currentVersion,
 String previousVersion)

Specified by:

startBaseline in class AbstractBaselinePlugin

startPackage

protected void startPackage(Object context,
 boolean mismatch,
 String packageName,
 String shortDelta,
 String delta,
 aQute.bnd.version.Version newerVersion,
 aQute.bnd.version.Version olderVersion,
 aQute.bnd.version.Version suggestedVersion,
 DiffMessage diffMessage,
 Map<String,String> attributes)

Specified by:

startPackage in class AbstractBaselinePlugin

startDiff

protected void startDiff(Object context,
 int depth,
 String type,
 String name,
 String delta,
 String shortDelta)

Specified by:

startDiff in class AbstractBaselinePlugin

endDiff

protected void endDiff(Object context,
 int depth)

Specified by:

endDiff in class AbstractBaselinePlugin

endPackage

protected void endPackage(Object context)

Specified by:

endPackage in class AbstractBaselinePlugin

endBaseline

protected void endBaseline(Object context)

Specified by:

endBaseline in class AbstractBaselinePlugin

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
 Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getBundle

private ResourceBundle getBundle(Locale locale)

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File outputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport