Replace deprecated methods (#198)

elharo · michael-o · commit 73b57d384122 · 2024-07-28T22:18:33.000+02:00
* Replace deprecated methods
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
@@ -30,9 +30,9 @@
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
-import org.codehaus.plexus.util.WriterFactory;
 import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
 import org.codehaus.plexus.util.xml.XMLWriter;
+import org.codehaus.plexus.util.xml.XmlStreamWriter;
 import org.codehaus.plexus.util.xml.XmlWriterUtil;
 
 /**
@@ -57,6 +57,7 @@ public class EffectiveSiteMojo extends AbstractSiteDescriptorMojo {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
         SiteModel siteModel = prepareSiteModel(getLocales().get(0));
 
@@ -148,7 +149,7 @@ private void writeEffectiveSite(SiteModel siteModel, XMLWriter writer) throws Mo
     }
 
     protected static void writeXmlFile(File output, String content) throws IOException {
-        try (Writer out = WriterFactory.newXmlWriter(output)) {
+        try (Writer out = new XmlStreamWriter(output)) {
             output.getParentFile().mkdirs();
 
             out.write(content);
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.java b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.java
@@ -29,7 +29,7 @@
 import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreException;
 import org.apache.maven.doxia.site.SiteModel;
 import org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer;
-import org.codehaus.plexus.util.WriterFactory;
+import org.codehaus.plexus.util.xml.XmlStreamWriter;
 
 /**
  * Attach a POM to an artifact.
@@ -49,10 +49,12 @@ public SiteDescriptorArtifactMetadata(Artifact artifact, SiteModel siteModel, Fi
         this.siteModel = siteModel;
     }
 
+    @Override
     public String getRemoteFilename() {
         return getFilename();
     }
 
+    @Override
     public String getLocalFilename(ArtifactRepository repository) {
         return getFilename();
     }
@@ -61,43 +63,50 @@ private String getFilename() {
         return getArtifactId() + "-" + artifact.getVersion() + "-" + file.getName();
     }
 
+    @Override
     public void storeInLocalRepository(ArtifactRepository localRepository, ArtifactRepository remoteRepository)
             throws RepositoryMetadataStoreException {
         File destination = new File(
                 localRepository.getBasedir(), localRepository.pathOfLocalRepositoryMetadata(this, remoteRepository));
 
         destination.getParentFile().mkdirs();
 
-        try (Writer writer = WriterFactory.newXmlWriter(destination)) {
+        try (Writer writer = new XmlStreamWriter(destination)) {
             new SiteXpp3Writer().write(writer, siteModel);
         } catch (IOException e) {
             throw new RepositoryMetadataStoreException("Error saving in local repository", e);
         }
     }
 
+    @Override
     public String toString() {
         return "site descriptor for " + artifact.getArtifactId() + " " + artifact.getVersion() + " " + file.getName();
     }
 
+    @Override
     public boolean storedInArtifactVersionDirectory() {
         return true;
     }
 
+    @Override
     public String getBaseVersion() {
         return artifact.getBaseVersion();
     }
 
+    @Override
     public Object getKey() {
         return "site descriptor " + artifact.getGroupId() + ":" + artifact.getArtifactId() + " " + file.getName();
     }
 
+    @Override
     public void merge(ArtifactMetadata metadata) {
         SiteDescriptorArtifactMetadata m = (SiteDescriptorArtifactMetadata) metadata;
         if (!m.file.equals(file)) {
             throw new IllegalStateException("Cannot add two different pieces of metadata for: " + getKey());
         }
     }
 
+    @Override
     public void merge(org.apache.maven.repository.legacy.metadata.ArtifactMetadata metadata) {
         // FIXME what todo here ?
     }
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
@@ -57,7 +57,6 @@
 import org.apache.maven.reporting.exec.MavenReportExecution;
 import org.apache.maven.reporting.exec.MavenReportExecutor;
 import org.apache.maven.reporting.exec.MavenReportExecutorRequest;
-import org.apache.maven.shared.utils.WriterFactory;
 import org.codehaus.plexus.util.ReaderFactory;
 
 import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
@@ -195,7 +194,7 @@ protected String getInputEncoding() {
      * @return The effective reporting output file encoding, never <code>null</code>.
      */
     protected String getOutputEncoding() {
-        return (outputEncoding == null) ? WriterFactory.UTF_8 : outputEncoding;
+        return outputEncoding == null ? "UTF-8" : outputEncoding;
     }
 
     /**
@@ -295,7 +294,7 @@ protected SiteRenderingContext createSiteRenderingContext(Locale locale)
 
             getLog().info(buffer().a("Rendering content with ")
                     .strong(skinArtifact.getId() + " skin")
-                    .toString());
+                    .build());
 
             context = siteRenderer.createContextForSkin(
                     skinArtifact, templateProperties, siteModel, project.getName(), locale);
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
@@ -82,6 +82,7 @@ public CategorySummaryDocumentRenderer(
         this.log = log;
     }
 
+    @Override
     public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
             throws RendererException, IOException {
         String msg = "Generating \"" + buffer().strong(title) + "\" report";
@@ -177,18 +178,22 @@ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderi
         siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
     }
 
+    @Override
     public String getOutputName() {
         return docRenderingContext.getOutputName();
     }
 
+    @Override
     public DocumentRenderingContext getRenderingContext() {
         return docRenderingContext;
     }
 
+    @Override
     public boolean isOverwrite() {
         return true;
     }
 
+    @Override
     public boolean isExternalReport() {
         return false;
     }
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
@@ -21,7 +21,9 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.OutputStream;
+import java.io.OutputStreamWriter;
 import java.io.Writer;
+import java.nio.file.Files;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
@@ -41,7 +43,6 @@
 import org.apache.maven.reporting.MavenReportException;
 import org.apache.maven.reporting.exec.MavenReportExecution;
 import org.codehaus.plexus.util.PathTool;
-import org.codehaus.plexus.util.WriterFactory;
 
 import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
 
@@ -229,13 +230,12 @@ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderi
         siteRenderer.mergeDocumentIntoSite(writer, mainSink, siteRenderingContext);
 
         // render sub-sinks, eventually created by multi-page reports
-        String outputName = "";
         List<MultiPageSubSink> sinks = multiPageSinkFactory.sinks();
 
         log.debug("Multipage report: " + sinks.size() + " subreports");
 
         for (MultiPageSubSink mySink : sinks) {
-            outputName = mySink.getOutputName();
+            String outputName = mySink.getOutputName();
             log.debug("  Rendering " + outputName);
 
             // Create directories if necessary
@@ -245,14 +245,11 @@ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderi
 
             File outputFile = new File(mySink.getOutputDirectory(), outputName);
 
-            try (Writer out = WriterFactory.newWriter(outputFile, siteRenderingContext.getOutputEncoding())) {
+            try (Writer out = new OutputStreamWriter(
+                    Files.newOutputStream(outputFile.toPath()), siteRenderingContext.getOutputEncoding())) {
                 siteRenderer.mergeDocumentIntoSite(out, mySink, siteRenderingContext);
-                mySink.close();
-                mySink = null;
             } finally {
-                if (mySink != null) {
-                    mySink.close();
-                }
+                mySink.close();
             }
         }
     }
@@ -262,6 +259,11 @@ public String getOutputName() {
         return docRenderingContext.getOutputName();
     }
 
+    @Override
+    public String getOutputPath() {
+        return getOutputName();
+    }
+
     @Override
     public DocumentRenderingContext getRenderingContext() {
         return docRenderingContext;
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
@@ -83,6 +83,7 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
         if (skip) {
             getLog().info("maven.site.skip = true: Skipping site generation");
@@ -104,7 +105,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                                         (!locale.equals(SiteTool.DEFAULT_LOCALE)
                                                 ? "locale '" + locale + "'"
                                                 : "default locale"))
-                                .toString());
+                                .build());
                 File outputDirectory = getOutputDirectory(locale);
                 List<MavenReportExecution> reports =
                         generateReports ? getReports(outputDirectory) : Collections.emptyList();
@@ -209,7 +210,7 @@ private List<DocumentRenderer> renderDoxiaDocuments(
                 mb.strong(entry.getValue() + " " + entry.getKey());
             }
 
-            getLog().info(mb.toString());
+            getLog().info(mb.build());
 
             siteRenderer.render(doxiaDocuments, context, outputDirectory);
         }
@@ -231,7 +232,7 @@ private List<DocumentRenderer> renderDoxiaDocuments(
                 mb.strong(entry.getValue() + " " + entry.getKey());
             }
 
-            getLog().info(mb.toString());
+            getLog().info(mb.build());
 
             siteRenderer.render(generatedDoxiaDocuments, context, outputDirectory);
         }
@@ -275,7 +276,7 @@ private void renderNonDoxiaDocuments(
                 mb.a("Rendering ");
                 mb.strong(count + " " + type + " document" + (count > 1 ? "s" : ""));
 
-                getLog().info(mb.toString());
+                getLog().info(mb.build());
             }
 
             siteRenderer.render(documents, context, outputDirectory);
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SitemapDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/SitemapDocumentRenderer.java
@@ -78,6 +78,7 @@ public SitemapDocumentRenderer(
         this.log = log;
     }
 
+    @Override
     public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
             throws RendererException, IOException {
         Locale locale = siteRenderingContext.getLocale();
@@ -162,18 +163,27 @@ private static String relativePath(String href) {
         return href.startsWith("/") ? "." + href : href;
     }
 
+    @Override
     public String getOutputName() {
         return docRenderingContext.getOutputName();
     }
 
+    @Override
+    public String getOutputPath() {
+        return getOutputName();
+    }
+
+    @Override
     public DocumentRenderingContext getRenderingContext() {
         return docRenderingContext;
     }
 
+    @Override
     public boolean isOverwrite() {
         return true;
     }
 
+    @Override
     public boolean isExternalReport() {
         return false;
     }
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
@@ -74,6 +74,7 @@ public class DoxiaFilter implements Filter {
     /**
      * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
      */
+    @Override
     public void init(FilterConfig filterConfig) throws ServletException {
         servletContext = filterConfig.getServletContext();
 
@@ -89,6 +90,7 @@ public void init(FilterConfig filterConfig) throws ServletException {
     /**
      * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)
      */
+    @Override
     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
             throws IOException, ServletException {
         HttpServletRequest req = (HttpServletRequest) servletRequest;
@@ -194,5 +196,6 @@ private void logDocumentRenderer(String path, String locale, DocumentRenderer do
     /**
      * @see javax.servlet.Filter#destroy()
      */
+    @Override
     public void destroy() {}
 }
diff --git a/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java b/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
@@ -74,6 +74,7 @@ public class SiteRunMojo extends AbstractSiteRenderingMojo {
     /**
      * @see org.apache.maven.plugin.AbstractMojo#execute()
      */
+    @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
         checkInputEncoding();
 
@@ -91,7 +92,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             throw new MojoExecutionException("Error executing Jetty", e);
         }
 
-        getLog().info(buffer().a("Started Jetty on ").strong(server.getURI()).toString());
+        getLog().info(buffer().a("Started Jetty on ").strong(server.getURI()).build());
 
         // Watch it
         try {

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreException;`
`30`	`30`	`import org.apache.maven.doxia.site.SiteModel;`
`31`	`31`	`import org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer;`
`32`		`-import org.codehaus.plexus.util.WriterFactory;`
	`32`	`+import org.codehaus.plexus.util.xml.XmlStreamWriter;`
`33`	`33`
`34`	`34`	`/**`
`35`	`35`	`* Attach a POM to an artifact.`
`@@ -49,10 +49,12 @@ public SiteDescriptorArtifactMetadata(Artifact artifact, SiteModel siteModel, Fi`
`49`	`49`	`this.siteModel = siteModel;`
`50`	`50`	`}`
`51`	`51`
	`52`	`+ @Override`
`52`	`53`	`public String getRemoteFilename() {`
`53`	`54`	`return getFilename();`
`54`	`55`	`}`
`55`	`56`
	`57`	`+ @Override`
`56`	`58`	`public String getLocalFilename(ArtifactRepository repository) {`
`57`	`59`	`return getFilename();`
`58`	`60`	`}`
`@@ -61,43 +63,50 @@ private String getFilename() {`
`61`	`63`	`return getArtifactId() + "-" + artifact.getVersion() + "-" + file.getName();`
`62`	`64`	`}`
`63`	`65`
	`66`	`+ @Override`
`64`	`67`	`public void storeInLocalRepository(ArtifactRepository localRepository, ArtifactRepository remoteRepository)`
`65`	`68`	`throws RepositoryMetadataStoreException {`
`66`	`69`	`File destination = new File(`
`67`	`70`	`localRepository.getBasedir(), localRepository.pathOfLocalRepositoryMetadata(this, remoteRepository));`
`68`	`71`
`69`	`72`	`destination.getParentFile().mkdirs();`
`70`	`73`
`71`		`- try (Writer writer = WriterFactory.newXmlWriter(destination)) {`
	`74`	`+ try (Writer writer = new XmlStreamWriter(destination)) {`
`72`	`75`	`new SiteXpp3Writer().write(writer, siteModel);`
`73`	`76`	`} catch (IOException e) {`
`74`	`77`	`throw new RepositoryMetadataStoreException("Error saving in local repository", e);`
`75`	`78`	`}`
`76`	`79`	`}`
`77`	`80`
	`81`	`+ @Override`
`78`	`82`	`public String toString() {`
`79`	`83`	`return "site descriptor for " + artifact.getArtifactId() + " " + artifact.getVersion() + " " + file.getName();`
`80`	`84`	`}`
`81`	`85`
	`86`	`+ @Override`
`82`	`87`	`public boolean storedInArtifactVersionDirectory() {`
`83`	`88`	`return true;`
`84`	`89`	`}`
`85`	`90`
	`91`	`+ @Override`
`86`	`92`	`public String getBaseVersion() {`
`87`	`93`	`return artifact.getBaseVersion();`
`88`	`94`	`}`
`89`	`95`
	`96`	`+ @Override`
`90`	`97`	`public Object getKey() {`
`91`	`98`	`return "site descriptor " + artifact.getGroupId() + ":" + artifact.getArtifactId() + " " + file.getName();`
`92`	`99`	`}`
`93`	`100`
	`101`	`+ @Override`
`94`	`102`	`public void merge(ArtifactMetadata metadata) {`
`95`	`103`	`SiteDescriptorArtifactMetadata m = (SiteDescriptorArtifactMetadata) metadata;`
`96`	`104`	`if (!m.file.equals(file)) {`
`97`	`105`	`throw new IllegalStateException("Cannot add two different pieces of metadata for: " + getKey());`
`98`	`106`	`}`
`99`	`107`	`}`
`100`	`108`
	`109`	`+ @Override`
`101`	`110`	`public void merge(org.apache.maven.repository.legacy.metadata.ArtifactMetadata metadata) {`
`102`	`111`	`// FIXME what todo here ?`
`103`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,7 @@ public CategorySummaryDocumentRenderer(`
`82`	`82`	`this.log = log;`
`83`	`83`	`}`
`84`	`84`
	`85`	`+ @Override`
`85`	`86`	`public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)`
`86`	`87`	`throws RendererException, IOException {`
`87`	`88`	`String msg = "Generating \"" + buffer().strong(title) + "\" report";`
`@@ -177,18 +178,22 @@ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderi`
`177`	`178`	`siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);`
`178`	`179`	`}`
`179`	`180`
	`181`	`+ @Override`
`180`	`182`	`public String getOutputName() {`
`181`	`183`	`return docRenderingContext.getOutputName();`
`182`	`184`	`}`
`183`	`185`
	`186`	`+ @Override`
`184`	`187`	`public DocumentRenderingContext getRenderingContext() {`
`185`	`188`	`return docRenderingContext;`
`186`	`189`	`}`
`187`	`190`
	`191`	`+ @Override`
`188`	`192`	`public boolean isOverwrite() {`
`189`	`193`	`return true;`
`190`	`194`	`}`
`191`	`195`
	`196`	`+ @Override`
`192`	`197`	`public boolean isExternalReport() {`
`193`	`198`	`return false;`
`194`	`199`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,7 @@ public SitemapDocumentRenderer(`
`78`	`78`	`this.log = log;`
`79`	`79`	`}`
`80`	`80`
	`81`	`+ @Override`
`81`	`82`	`public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)`
`82`	`83`	`throws RendererException, IOException {`
`83`	`84`	`Locale locale = siteRenderingContext.getLocale();`
`@@ -162,18 +163,27 @@ private static String relativePath(String href) {`
`162`	`163`	`return href.startsWith("/") ? "." + href : href;`
`163`	`164`	`}`
`164`	`165`
	`166`	`+ @Override`
`165`	`167`	`public String getOutputName() {`
`166`	`168`	`return docRenderingContext.getOutputName();`
`167`	`169`	`}`
`168`	`170`
	`171`	`+ @Override`
	`172`	`+ public String getOutputPath() {`
	`173`	`+ return getOutputName();`
	`174`	`+ }`
	`175`	`+`
	`176`	`+ @Override`
`169`	`177`	`public DocumentRenderingContext getRenderingContext() {`
`170`	`178`	`return docRenderingContext;`
`171`	`179`	`}`
`172`	`180`
	`181`	`+ @Override`
`173`	`182`	`public boolean isOverwrite() {`
`174`	`183`	`return true;`
`175`	`184`	`}`
`176`	`185`
	`186`	`+ @Override`
`177`	`187`	`public boolean isExternalReport() {`
`178`	`188`	`return false;`
`179`	`189`	`}`