This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
commit 346a35a6f8c96ccb0368f539d27e00b395f84d9a Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Tue Nov 17 01:49:12 2026 +0000 Use System.lineSeparator(), @Override and try-with-resources --- .../main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java | 5 +++++ .../main/java/org/apache/maven/doxia/tools/ReportComparator.java | 1 + .../site/inheritance/DefaultSiteModelInheritanceAssembler.java | 2 ++ .../org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java | 7 +++++++ .../org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java | 6 ++++++ .../org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java | 6 ++++++ .../test/java/org/apache/maven/doxia/siterenderer/AptVerifier.java | 1 + .../org/apache/maven/doxia/siterenderer/AttributesVerifier.java | 1 + .../java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java | 1 + .../java/org/apache/maven/doxia/siterenderer/EntitiesVerifier.java | 1 + .../test/java/org/apache/maven/doxia/siterenderer/FaqVerifier.java | 1 + .../org/apache/maven/doxia/siterenderer/JavascriptVerifier.java | 1 + .../java/org/apache/maven/doxia/siterenderer/MermaidVerifier.java | 1 + .../org/apache/maven/doxia/siterenderer/MultipleBlockVerifier.java | 1 + .../org/apache/maven/doxia/siterenderer/NestedItemsVerifier.java | 1 + 15 files changed, 36 insertions(+) diff --git a/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java b/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java index ae4c086..00b918f 100644 --- a/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java +++ b/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java @@ -140,6 +140,7 @@ public class DefaultSiteTool implements SiteTool { // ---------------------------------------------------------------------- /** {@inheritDoc} */ + @Override public Artifact getSkinArtifactFromRepository( RepositorySystemSession repoSession, List<RemoteRepository> remoteProjectRepositories, Skin skin) throws SiteToolException { @@ -177,6 +178,7 @@ public class DefaultSiteTool implements SiteTool { * implemented method from a different library such as org.apache.http.client.utils.URIUtils#resolve. */ @Deprecated + @Override public String getRelativePath(String to, String from) { Objects.requireNonNull(to, "to cannot be null"); Objects.requireNonNull(from, "from cannot be null"); @@ -303,6 +305,7 @@ public class DefaultSiteTool implements SiteTool { } /** {@inheritDoc} */ + @Override public File getSiteDescriptor(File siteDirectory, Locale locale) { Objects.requireNonNull(siteDirectory, "siteDirectory cannot be null"); Objects.requireNonNull(locale, "locale cannot be null"); @@ -677,6 +680,7 @@ public class DefaultSiteTool implements SiteTool { } /** {@inheritDoc} */ + @Override public void populateReportsMenu(SiteModel siteModel, Locale locale, Map<String, List<MavenReport>> categories) { Objects.requireNonNull(siteModel, "siteModel cannot be null"); Objects.requireNonNull(locale, "locale cannot be null"); @@ -722,6 +726,7 @@ public class DefaultSiteTool implements SiteTool { } /** {@inheritDoc} */ + @Override public List<Locale> getSiteLocales(String locales) { if (locales == null) { return Collections.singletonList(DEFAULT_LOCALE); diff --git a/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/ReportComparator.java b/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/ReportComparator.java index 4aac8a9..d90adb9 100644 --- a/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/ReportComparator.java +++ b/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/ReportComparator.java @@ -46,6 +46,7 @@ public class ReportComparator implements Comparator<MavenReport> { } /** {@inheritDoc} */ + @Override public int compare(MavenReport r1, MavenReport r2) { Collator collator = Collator.getInstance(locale); return collator.compare(r1.getName(locale), r2.getName(locale)); diff --git a/doxia-site-model/src/main/java/org/apache/maven/doxia/site/inheritance/DefaultSiteModelInheritanceAssembler.java b/doxia-site-model/src/main/java/org/apache/maven/doxia/site/inheritance/DefaultSiteModelInheritanceAssembler.java index d3821ef..08652d8 100644 --- a/doxia-site-model/src/main/java/org/apache/maven/doxia/site/inheritance/DefaultSiteModelInheritanceAssembler.java +++ b/doxia-site-model/src/main/java/org/apache/maven/doxia/site/inheritance/DefaultSiteModelInheritanceAssembler.java @@ -42,6 +42,7 @@ import org.codehaus.plexus.util.xml.Xpp3Dom; @Named public class DefaultSiteModelInheritanceAssembler implements SiteModelInheritanceAssembler { /** {@inheritDoc} */ + @Override public void assembleModelInheritance( String name, SiteModel child, SiteModel parent, String childBaseUrl, String parentBaseUrl) { if (parent == null || !child.isMergeParent()) { @@ -90,6 +91,7 @@ public class DefaultSiteModelInheritanceAssembler implements SiteModelInheritanc } /** {@inheritDoc} */ + @Override public void resolvePaths(final SiteModel siteModel, final String baseUrl) { if (baseUrl == null) { return; diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java index 26589b8..772683f 100644 --- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java +++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java @@ -188,6 +188,7 @@ public class DefaultSiteRenderer implements Renderer { // ---------------------------------------------------------------------- /** {@inheritDoc} */ + @Override public Map<String, DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws IOException, RendererException { Map<String, DocumentRenderer> files = new LinkedHashMap<>(); @@ -390,6 +391,7 @@ public class DefaultSiteRenderer implements Renderer { } /** {@inheritDoc} */ + @Override public void render( Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) throws RendererException, IOException { @@ -441,6 +443,7 @@ public class DefaultSiteRenderer implements Renderer { } /** {@inheritDoc} */ + @Override public void renderDocument( Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext) throws RendererException { @@ -759,6 +762,7 @@ public class DefaultSiteRenderer implements Renderer { } /** {@inheritDoc} */ + @Override public void mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext) throws RendererException { String templateName = siteRenderingContext.getTemplateName(); @@ -830,6 +834,7 @@ public class DefaultSiteRenderer implements Renderer { /** {@inheritDoc} */ @Deprecated + @Override public SiteRenderingContext createContextForSkin( Artifact skin, Map<String, ?> attributes, SiteModel siteModel, String defaultTitle, Locale locale) throws IOException, RendererException { @@ -840,6 +845,7 @@ public class DefaultSiteRenderer implements Renderer { } /** {@inheritDoc} */ + @Override public SiteRenderingContext createContextForSkin( File skinFile, String skinId, @@ -935,6 +941,7 @@ public class DefaultSiteRenderer implements Renderer { } /** {@inheritDoc} */ + @Override public void copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) throws IOException { ZipFile file = getZipFile(siteRenderingContext.getSkinFile()); diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java index c1d438f..6634a9b 100644 --- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java +++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java @@ -41,6 +41,7 @@ public class DoxiaDocumentRenderer implements DocumentRenderer { } /** {@inheritDoc} */ + @Override public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext) throws IOException, RendererException { siteRenderer.renderDocument(writer, docRenderingContext, siteRenderingContext); @@ -50,25 +51,30 @@ public class DoxiaDocumentRenderer implements DocumentRenderer { * @deprecated use {@link #getOutputPath()} instead */ @Deprecated + @Override public String getOutputName() { return getOutputPath(); } /** {@inheritDoc} */ + @Override public String getOutputPath() { return docRenderingContext.getOutputPath(); } /** {@inheritDoc} */ + @Override public DocumentRenderingContext getRenderingContext() { return docRenderingContext; } /** {@inheritDoc} */ + @Override public boolean isOverwrite() { return false; } + @Override public boolean isExternalReport() { return false; } diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java index 6cfac44..25a8204 100644 --- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java +++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java @@ -327,21 +327,25 @@ public class SiteRendererSink extends Xhtml5Sink implements DocumentContent { // DocumentContent interface /** {@inheritDoc} */ + @Override public String getTitle() { return title; } /** {@inheritDoc} */ + @Override public List<String> getAuthors() { return authors; } /** {@inheritDoc} */ + @Override public String getDate() { return date; } /** {@inheritDoc} */ + @Override public String getBody() { String body = writer.toString(); @@ -349,6 +353,7 @@ public class SiteRendererSink extends Xhtml5Sink implements DocumentContent { } /** {@inheritDoc} */ + @Override public String getHead() { String head = headWriter.toString(); @@ -356,6 +361,7 @@ public class SiteRendererSink extends Xhtml5Sink implements DocumentContent { } /** {@inheritDoc} */ + @Override public DocumentRenderingContext getRenderingContext() { return docRenderingContext; } diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AptVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AptVerifier.java index f7213a1..2422c38 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AptVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AptVerifier.java @@ -43,6 +43,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; */ public class AptVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { HtmlPage page = htmlPage(file); assertNotNull(page); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AttributesVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AttributesVerifier.java index 831635d..40bb75b 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AttributesVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/AttributesVerifier.java @@ -53,6 +53,7 @@ import static org.junit.jupiter.api.Assertions.assertSame; @SuppressWarnings("MethodLength") public class AttributesVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { HtmlPage page = htmlPage(file); assertNotNull(page); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java index 929478c..8e29126 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/CommentsVerifier.java @@ -29,6 +29,7 @@ import static org.junit.jupiter.api.Assertions.assertTrue; */ public class CommentsVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { String content = FileUtils.fileRead(new File(file), "UTF-8"); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/EntitiesVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/EntitiesVerifier.java index 8e235c9..0886fce 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/EntitiesVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/EntitiesVerifier.java @@ -43,6 +43,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; */ public class EntitiesVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { HtmlPage page = htmlPage(file); assertNotNull(page); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/FaqVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/FaqVerifier.java index 8958dad..615cc50 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/FaqVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/FaqVerifier.java @@ -42,6 +42,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; @SuppressWarnings("MethodLength") public class FaqVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { HtmlPage page = htmlPage(file); assertNotNull(page); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/JavascriptVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/JavascriptVerifier.java index 74a75f4..7ceb5c8 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/JavascriptVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/JavascriptVerifier.java @@ -53,6 +53,7 @@ public class JavascriptVerifier extends AbstractVerifier { * * @throws Exception if something goes wrong. */ + @Override public void verify(String file) throws Exception { File jsTest = getTestFile(file); assertNotNull(jsTest); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MermaidVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MermaidVerifier.java index 74225f3..e877ea2 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MermaidVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MermaidVerifier.java @@ -58,6 +58,7 @@ public class MermaidVerifier extends AbstractVerifier { * * @throws Exception if something goes wrong. */ + @Override public void verify(String file) throws Exception { File jsTest = getTestFile(file); assertNotNull(jsTest); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MultipleBlockVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MultipleBlockVerifier.java index 49e5a5d..2c178c9 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MultipleBlockVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/MultipleBlockVerifier.java @@ -40,6 +40,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; */ public class MultipleBlockVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { HtmlPage page = htmlPage(file); assertNotNull(page); diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/NestedItemsVerifier.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/NestedItemsVerifier.java index 95ddfa2..d34d7c6 100644 --- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/NestedItemsVerifier.java +++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/NestedItemsVerifier.java @@ -46,6 +46,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; @SuppressWarnings("MethodLength") public class NestedItemsVerifier extends AbstractVerifier { /** {@inheritDoc} */ + @Override public void verify(String file) throws Exception { HtmlPage page = htmlPage(file); assertNotNull(page);
