Renames

apache · Mar 26, 2023 · c3dcdd5 · c3dcdd5
1 parent e27ac13
commit c3dcdd5
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 28 deletions.
diff --git a/pom.xml b/pom.xml
@@ -198,7 +198,7 @@ under the License.
     <!-- for dependencies -->
     <jettyVersion>9.4.50.v20221201</jettyVersion>
     <doxiaVersion>2.0.0-M6</doxiaVersion>
-    <doxiaSitetoolsVersion>2.0.0-M6</doxiaSitetoolsVersion>
+    <doxiaSitetoolsVersion>2.0.0-M7-SNAPSHOT</doxiaSitetoolsVersion>
     <wagonVersion>3.5.3</wagonVersion>
     <slf4jVersion>1.7.36</slf4jVersion>
     <!-- for ITs -->

diff --git a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
@@ -36,9 +36,9 @@
 import org.apache.maven.doxia.site.decoration.Menu;
 import org.apache.maven.doxia.site.decoration.MenuItem;
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
 import org.apache.maven.doxia.siterenderer.RendererException;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 import org.apache.maven.doxia.tools.SiteTool;
 import org.apache.maven.doxia.tools.SiteToolException;
@@ -98,7 +98,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
      * Site renderer.
      */
     @Component
-    protected Renderer siteRenderer;
+    protected SiteRenderer siteRenderer;
 
     /**
      * Directory containing generated documentation in source format (Doxia supported markup).
@@ -346,7 +346,8 @@ protected Map<String, MavenReport> locateReports(
                         + mavenReportExecution.getPlugin().getVersion()
                         + ':'
                         + mavenReportExecution.getGoal();
-                RenderingContext docRenderingContext = new RenderingContext(siteDirectory, outputName, reportMojoInfo);
+                DocumentRenderingContext docRenderingContext =
+                        new DocumentRenderingContext(siteDirectory, outputName, reportMojoInfo);
                 DocumentRenderer docRenderer =
                         new ReportDocumentRenderer(mavenReportExecution, docRenderingContext, getLog());
                 documents.put(outputName, docRenderer);
@@ -407,7 +408,7 @@ protected Map<String, DocumentRenderer> locateDocuments(
             // add "Project Information" category summary document
             List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION);
 
-            RenderingContext docRenderingContext = new RenderingContext(
+            DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
                     siteDirectory, "project-info.html", getSitePluginInfo() + ":CategorySummaryDocumentRenderer");
             String title = i18n.getString("site-plugin", locale, "report.information.title");
             String desc1 = i18n.getString("site-plugin", locale, "report.information.description1");
@@ -425,7 +426,7 @@ protected Map<String, DocumentRenderer> locateDocuments(
         if (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) {
             // add "Project Reports" category summary document
             List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_REPORTS);
-            RenderingContext docRenderingContext = new RenderingContext(
+            DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
                     siteDirectory, "project-reports.html", getSitePluginInfo() + ":CategorySummaryDocumentRenderer");
             String title = i18n.getString("site-plugin", locale, "report.project.title");
             String desc1 = i18n.getString("site-plugin", locale, "report.project.description1");

diff --git a/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java
@@ -26,9 +26,9 @@
 
 import org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
 import org.apache.maven.doxia.siterenderer.RendererException;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
 import org.apache.maven.plugin.logging.Log;
@@ -41,7 +41,7 @@
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  */
 public class CategorySummaryDocumentRenderer implements DocumentRenderer {
-    private RenderingContext docRenderingContext;
+    private DocumentRenderingContext docRenderingContext;
 
     private String title;
 
@@ -56,7 +56,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer {
     private final Log log;
 
     public CategorySummaryDocumentRenderer(
-            RenderingContext docRenderingContext,
+            DocumentRenderingContext docRenderingContext,
             String title,
             String desc1,
             String desc2,
@@ -66,7 +66,7 @@ public CategorySummaryDocumentRenderer(
     }
 
     public CategorySummaryDocumentRenderer(
-            RenderingContext docRenderingContext,
+            DocumentRenderingContext docRenderingContext,
             String title,
             String desc1,
             String desc2,
@@ -82,7 +82,7 @@ public CategorySummaryDocumentRenderer(
         this.log = log;
     }
 
-    public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext)
+    public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
             throws RendererException, FileNotFoundException {
         SiteRendererSink sink = new SiteRendererSink(docRenderingContext);
 
@@ -176,7 +176,7 @@ public String getOutputName() {
         return docRenderingContext.getOutputName();
     }
 
-    public RenderingContext getRenderingContext() {
+    public DocumentRenderingContext getRenderingContext() {
         return docRenderingContext;
     }
 

diff --git a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
@@ -30,9 +30,9 @@
 import org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.doxia.sink.SinkFactory;
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
 import org.apache.maven.doxia.siterenderer.RendererException;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
 import org.apache.maven.plugin.logging.Log;
@@ -55,7 +55,7 @@
 public class ReportDocumentRenderer implements DocumentRenderer {
     private final MavenReport report;
 
-    private final RenderingContext docRenderingContext;
+    private final DocumentRenderingContext docRenderingContext;
 
     private final String reportMojoInfo;
 
@@ -64,7 +64,7 @@ public class ReportDocumentRenderer implements DocumentRenderer {
     private final Log log;
 
     public ReportDocumentRenderer(
-            MavenReportExecution mavenReportExecution, RenderingContext docRenderingContext, Log log) {
+            MavenReportExecution mavenReportExecution, DocumentRenderingContext docRenderingContext, Log log) {
         this.report = mavenReportExecution.getMavenReport();
 
         this.docRenderingContext = docRenderingContext;
@@ -86,7 +86,7 @@ private static class MultiPageSubSink extends SiteRendererSink {
 
         private String outputName;
 
-        MultiPageSubSink(File outputDir, String outputName, RenderingContext docRenderingContext) {
+        MultiPageSubSink(File outputDir, String outputName, DocumentRenderingContext docRenderingContext) {
             super(docRenderingContext);
             this.outputName = outputName;
             this.outputDir = outputDir;
@@ -108,16 +108,16 @@ private static class MultiPageSinkFactory implements SinkFactory {
         private MavenReport report;
 
         /**
-         * The main RenderingContext, which is the base for the RenderingContext of subpages
+         * The main DocumentRenderingContext, which is the base for the DocumentRenderingContext of subpages
          */
-        private RenderingContext docRenderingContext;
+        private DocumentRenderingContext docRenderingContext;
 
         /**
          * List of sinks (subpages) associated to this report
          */
         private List<MultiPageSubSink> sinks = new ArrayList<MultiPageSubSink>();
 
-        MultiPageSinkFactory(MavenReport report, RenderingContext docRenderingContext) {
+        MultiPageSinkFactory(MavenReport report, DocumentRenderingContext docRenderingContext) {
             this.report = report;
             this.docRenderingContext = docRenderingContext;
         }
@@ -128,7 +128,7 @@ public Sink createSink(File outputDir, String outputName) {
             String outputRelativeToTargetSite = PathTool.getRelativeFilePath(
                     report.getReportOutputDirectory().getPath(), new File(outputDir, outputName).getPath());
 
-            RenderingContext subSinkContext = new RenderingContext(
+            DocumentRenderingContext subSinkContext = new DocumentRenderingContext(
                     docRenderingContext.getBasedir(),
                     docRenderingContext.getBasedirRelativePath(),
                     outputRelativeToTargetSite,
@@ -170,7 +170,7 @@ public List<MultiPageSubSink> sinks() {
     }
 
     @Override
-    public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext)
+    public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
             throws RendererException, FileNotFoundException {
         Locale locale = siteRenderingContext.getLocale();
         String localReportName = report.getName(locale);
@@ -269,7 +269,7 @@ public String getOutputName() {
     }
 
     @Override
-    public RenderingContext getRenderingContext() {
+    public DocumentRenderingContext getRenderingContext() {
         return docRenderingContext;
     }
 

diff --git a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java
@@ -37,8 +37,8 @@
 
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
 import org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer;
-import org.apache.maven.doxia.siterenderer.Renderer;
 import org.apache.maven.doxia.siterenderer.RendererException;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 import org.apache.maven.plugins.site.render.ReportDocumentRenderer;
 import org.eclipse.jetty.http.MimeTypes;
@@ -63,7 +63,7 @@ public class DoxiaFilter implements Filter {
 
     private File outputDirectory;
 
-    private Renderer siteRenderer;
+    private SiteRenderer siteRenderer;
 
     private Map<String, DoxiaBean> i18nDoxiaContexts;
 
@@ -77,7 +77,7 @@ public void init(FilterConfig filterConfig) throws ServletException {
 
         outputDirectory = (File) servletContext.getAttribute(OUTPUT_DIRECTORY_KEY);
 
-        siteRenderer = (Renderer) servletContext.getAttribute(SITE_RENDERER_KEY);
+        siteRenderer = (SiteRenderer) servletContext.getAttribute(SITE_RENDERER_KEY);
 
         i18nDoxiaContexts = (Map<String, DoxiaBean>) servletContext.getAttribute(I18N_DOXIA_CONTEXTS_KEY);