Class 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 class  BaselineReport.Context  
    • Constructor Summary

      Constructors 
      Constructor Description
      BaselineReport()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 generate​(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale)  
      private java.util.ResourceBundle getBundle​(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, 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

      • outputDirectory

        @Parameter(defaultValue="${project.reporting.outputDirectory}")
        private java.io.File outputDirectory
        Specifies the directory where the report will be generated.
    • Constructor Detail

      • BaselineReport

        public BaselineReport()
    • Method Detail

      • startBaseline

        protected void startBaseline​(java.lang.Object context,
                                     java.lang.String generationDate,
                                     java.lang.String bundleName,
                                     java.lang.String currentVersion,
                                     java.lang.String previousVersion)
        Specified by:
        startBaseline in class AbstractBaselinePlugin
      • 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,
                                    DiffMessage diffMessage,
                                    java.util.Map<java.lang.String,​java.lang.String> attributes)
        Specified by:
        startPackage in class AbstractBaselinePlugin
      • 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)
        Specified by:
        startDiff in class AbstractBaselinePlugin
      • 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
      • getBundle

        private java.util.ResourceBundle getBundle​(java.util.Locale locale)
      • 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