org.apache.felix.bundleplugin.baseline

Class BaselineReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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)
@Execute(phase=SITE)
public final class BaselineReport
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenReport

BND Baseline report.

Since:

2.4.1

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	comparisonClassifier Classifier for the artifact to compare the current code against.
protected java.lang.String	comparisonVersion Version to compare the current code against.
protected org.apache.maven.artifact.factory.ArtifactFactory	factory
protected boolean	failOnError Whether to fail on errors.
protected boolean	failOnWarning Whether to fail on warnings.
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver
protected org.apache.maven.execution.MavenSession	session
protected boolean	skip Flag to easily skip execution.
protected java.util.List<java.lang.String>	supportedProjectTypes Project types which this plugin supports.

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 and Description
BaselineReport()

Method Summary

Methods

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

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

Field Detail

skip

@Parameter(property="baseline.skip",
           defaultValue="false")
protected boolean skip

Flag to easily skip execution.

failOnError

@Parameter(property="baseline.failOnError",
           defaultValue="true")
protected boolean failOnError

Whether to fail on errors.

failOnWarning

@Parameter(property="baseline.failOnWarning",
           defaultValue="false")
protected boolean failOnWarning

Whether to fail on warnings.

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

resolver

@Component
protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

factory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory factory

comparisonVersion

@Parameter(defaultValue="(,${project.version})",
           property="comparisonVersion")
protected java.lang.String comparisonVersion

Version to compare the current code against.

comparisonClassifier

@Parameter(property="comparisonClassifier")
protected java.lang.String comparisonClassifier

Classifier for the artifact to compare the current code against.

supportedProjectTypes

@Parameter
protected java.util.List<java.lang.String> supportedProjectTypes

Project types which this plugin supports.

Constructor Detail

BaselineReport

public BaselineReport()

Method Detail

init

protected java.lang.Object init(java.lang.Object context)

close

protected void close(java.lang.Object context)

startBaseline

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

startPackage

protected void startPackage(java.lang.Object context,
                boolean mismatch,
                java.lang.String packageName,
                java.lang.String shortDelta,
                java.lang.String delta,
                aQute.bnd.version.Version newerVersion,
                aQute.bnd.version.Version olderVersion,
                aQute.bnd.version.Version suggestedVersion,
                org.apache.felix.bundleplugin.baseline.DiffMessage diffMessage,
                java.util.Map<java.lang.String,java.lang.String> attributes)

startDiff

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

endDiff

protected void endDiff(java.lang.Object context,
           int depth)

endPackage

protected void endPackage(java.lang.Object context)

endBaseline

protected void endBaseline(java.lang.Object context)

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
            java.util.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 java.lang.String getCategoryName()

Specified by:

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

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Specified by:

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

getName

public java.lang.String getName(java.util.Locale locale)

Specified by:

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

getOutputName

public java.lang.String getOutputName()

Specified by:

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

getReportOutputDirectory

public java.io.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(java.io.File outputDirectory)

Specified by:

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

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

execute

protected void execute(java.lang.Object context)
                throws org.apache.maven.plugin.MojoExecutionException,
                       org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException