This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch LOG4J2-3628 in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 692aa41934001e6bd9364fed8a4dcad9f15cf084 Author: Volkan Yazıcı <[email protected]> AuthorDate: Wed Nov 23 22:16:57 2022 +0100 LOG4J2-3628 Address Spotless complaints. --- .../logging/log4j/internal/util/AsciiDocUtils.java | 2 +- .../internal/util/PositionalSaxEventHandler.java | 6 +++--- .../logging/log4j/internal/util/StringUtils.java | 2 +- .../logging/log4j/internal/util/XmlReader.java | 20 ++++++++++---------- .../logging/log4j/internal/util/XmlWriter.java | 22 +++++++++++----------- .../internal/util/changelog/ChangelogEntry.java | 14 +++++++++----- .../internal/util/changelog/ChangelogFiles.java | 2 +- .../internal/util/changelog/ChangelogRelease.java | 6 +++--- .../util/changelog/exporter/AsciiDocExporter.java | 14 +++++++------- .../changelog/exporter/AsciiDocExporterArgs.java | 2 +- .../util/changelog/importer/MavenChanges.java | 12 ++++++------ .../changelog/importer/MavenChangesImporter.java | 10 +++++----- .../importer/MavenChangesImporterArgs.java | 2 +- .../util/changelog/releaser/ChangelogReleaser.java | 12 ++++++------ .../changelog/releaser/ChangelogReleaserArgs.java | 2 +- 15 files changed, 66 insertions(+), 62 deletions(-) diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/AsciiDocUtils.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/AsciiDocUtils.java index 91cfb41ac1..92f010bd3e 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/AsciiDocUtils.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/AsciiDocUtils.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/PositionalSaxEventHandler.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/PositionalSaxEventHandler.java index 7ca575c951..48c03d4653 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/PositionalSaxEventHandler.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/PositionalSaxEventHandler.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,6 +16,8 @@ */ package org.apache.logging.log4j.internal.util; +import java.util.Stack; + import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; @@ -23,8 +25,6 @@ import org.xml.sax.Attributes; import org.xml.sax.Locator; import org.xml.sax.helpers.DefaultHandler; -import java.util.Stack; - /** * A SAX2 event handler adding the associated line number to each emitted nodes' user data. * <p> diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/StringUtils.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/StringUtils.java index 950e5f5844..93bc1c942a 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/StringUtils.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/StringUtils.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlReader.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlReader.java index 33c649b4cf..64f994d55d 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlReader.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlReader.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,15 +16,6 @@ */ package org.apache.logging.log4j.internal.util; -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; -import org.w3c.dom.NodeList; - -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.parsers.SAXParser; -import javax.xml.parsers.SAXParserFactory; import java.io.FileInputStream; import java.io.InputStream; import java.nio.file.Path; @@ -32,6 +23,15 @@ import java.util.List; import java.util.stream.Collectors; import java.util.stream.IntStream; import java.util.stream.Stream; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.SAXParser; +import javax.xml.parsers.SAXParserFactory; + +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; /** * A SAX2-based XML reader. diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlWriter.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlWriter.java index 8eeadf182a..efc713dbaf 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlWriter.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/XmlWriter.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,16 +16,6 @@ */ package org.apache.logging.log4j.internal.util; -import org.w3c.dom.Comment; -import org.w3c.dom.Document; - -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.transform.OutputKeys; -import javax.xml.transform.Transformer; -import javax.xml.transform.TransformerFactory; -import javax.xml.transform.dom.DOMSource; -import javax.xml.transform.stream.StreamResult; import java.io.StringWriter; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; @@ -33,6 +23,16 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.StandardOpenOption; import java.util.function.Consumer; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.transform.OutputKeys; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.dom.DOMSource; +import javax.xml.transform.stream.StreamResult; + +import org.w3c.dom.Comment; +import org.w3c.dom.Document; public final class XmlWriter { diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogEntry.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogEntry.java index f04f2a59a4..5ee776afed 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogEntry.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogEntry.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,15 +16,15 @@ */ package org.apache.logging.log4j.internal.util.changelog; -import org.apache.logging.log4j.internal.util.XmlReader; -import org.apache.logging.log4j.internal.util.XmlWriter; -import org.w3c.dom.Element; - import java.nio.file.Path; import java.util.List; import java.util.Locale; import java.util.stream.Collectors; +import org.apache.logging.log4j.internal.util.XmlReader; +import org.apache.logging.log4j.internal.util.XmlWriter; +import org.w3c.dom.Element; + import static org.apache.logging.log4j.internal.util.StringUtils.trimNullable; public final class ChangelogEntry { @@ -182,6 +182,10 @@ public final class ChangelogEntry { final String authorName = authorElement.hasAttribute("name") ? authorElement.getAttribute("name") : null; + if (authorId == null && authorName == null) { + throw XmlReader.failureAtXmlNode( + authorElement, "`author` must have at least one of `id` or `name` attributes"); + } return new Author(authorId, authorName); }) .collect(Collectors.toList()); diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogFiles.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogFiles.java index 92a2b94bef..899d252ce0 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogFiles.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogFiles.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogRelease.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogRelease.java index 38c62019ae..cb8fd0db42 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogRelease.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/ChangelogRelease.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,12 +16,12 @@ */ package org.apache.logging.log4j.internal.util.changelog; +import java.nio.file.Path; + import org.apache.logging.log4j.internal.util.XmlReader; import org.apache.logging.log4j.internal.util.XmlWriter; import org.w3c.dom.Element; -import java.nio.file.Path; - import static org.apache.logging.log4j.internal.util.StringUtils.trimNullable; public final class ChangelogRelease { diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporter.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporter.java index 380c6f8f57..57feb8ee25 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporter.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporter.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,11 +16,6 @@ */ package org.apache.logging.log4j.internal.util.changelog.exporter; -import org.apache.logging.log4j.internal.util.AsciiDocUtils; -import org.apache.logging.log4j.internal.util.changelog.ChangelogEntry; -import org.apache.logging.log4j.internal.util.changelog.ChangelogFiles; -import org.apache.logging.log4j.internal.util.changelog.ChangelogRelease; - import java.io.IOException; import java.io.UncheckedIOException; import java.nio.charset.StandardCharsets; @@ -35,6 +30,11 @@ import java.util.Map; import java.util.stream.Collectors; import java.util.stream.Stream; +import org.apache.logging.log4j.internal.util.AsciiDocUtils; +import org.apache.logging.log4j.internal.util.changelog.ChangelogEntry; +import org.apache.logging.log4j.internal.util.changelog.ChangelogFiles; +import org.apache.logging.log4j.internal.util.changelog.ChangelogRelease; + public final class AsciiDocExporter { private static final String TARGET_RELATIVE_DIRECTORY = "src/site/asciidoc/changelog"; @@ -400,7 +400,7 @@ public final class AsciiDocExporter { .append('\n') .append(AUTO_GENERATION_WARNING_ASCIIDOC) .append("\n= Release changelogs\n\n") - .append("* [????-??-??] xref:unreleased.adoc[Unreleased]\n"); + .append("* xref:unreleased.adoc[Unreleased]\n"); for (int releaseIndex = changelogReleases.size() - 1; releaseIndex >= 0; releaseIndex--) { final ChangelogRelease changelogRelease = changelogReleases.get(releaseIndex); final String asciiDocFilename = changelogReleaseAsciiDocFilename(changelogRelease); diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporterArgs.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporterArgs.java index 50bf63806d..fb26a6f10f 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporterArgs.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/exporter/AsciiDocExporterArgs.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChanges.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChanges.java index 5af2afd0b0..be5fe682a3 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChanges.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChanges.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,16 +16,16 @@ */ package org.apache.logging.log4j.internal.util.changelog.importer; -import org.apache.logging.log4j.internal.util.XmlReader; -import org.w3c.dom.Element; -import org.w3c.dom.Node; -import org.w3c.dom.NodeList; - import java.nio.file.Path; import java.util.ArrayList; import java.util.List; import java.util.Locale; +import org.apache.logging.log4j.internal.util.XmlReader; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + import static org.apache.logging.log4j.internal.util.StringUtils.isBlank; import static org.apache.logging.log4j.internal.util.StringUtils.trimNullable; import static org.apache.logging.log4j.internal.util.XmlReader.failureAtXmlNode; diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporter.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporter.java index 15d16901db..7f2c088218 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporter.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporter.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,14 +16,14 @@ */ package org.apache.logging.log4j.internal.util.changelog.importer; -import org.apache.logging.log4j.internal.util.changelog.ChangelogEntry; -import org.apache.logging.log4j.internal.util.changelog.ChangelogFiles; -import org.apache.logging.log4j.internal.util.changelog.ChangelogRelease; - import java.nio.file.Path; import java.util.ArrayList; import java.util.List; +import org.apache.logging.log4j.internal.util.changelog.ChangelogEntry; +import org.apache.logging.log4j.internal.util.changelog.ChangelogFiles; +import org.apache.logging.log4j.internal.util.changelog.ChangelogRelease; + import static org.apache.logging.log4j.internal.util.StringUtils.isBlank; public final class MavenChangesImporter { diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporterArgs.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporterArgs.java index 5b7199d2cb..7e01cd1e45 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporterArgs.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/importer/MavenChangesImporterArgs.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaser.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaser.java index 5865e5970c..c4e47d1b66 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaser.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaser.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -16,17 +16,17 @@ */ package org.apache.logging.log4j.internal.util.changelog.releaser; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.time.LocalDate; + import org.apache.logging.log4j.internal.util.AsciiDocUtils; import org.apache.logging.log4j.internal.util.XmlReader; import org.apache.logging.log4j.internal.util.changelog.ChangelogFiles; import org.apache.logging.log4j.internal.util.changelog.ChangelogRelease; import org.w3c.dom.Element; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; -import java.time.LocalDate; - import static java.time.format.DateTimeFormatter.BASIC_ISO_DATE; import static org.apache.logging.log4j.internal.util.StringUtils.isBlank; import static org.apache.logging.log4j.internal.util.StringUtils.trimNullable; diff --git a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaserArgs.java b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaserArgs.java index df89934424..357778d9e4 100644 --- a/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaserArgs.java +++ b/log4j-internal-util/src/main/java/org/apache/logging/log4j/internal/util/changelog/releaser/ChangelogReleaserArgs.java @@ -6,7 +6,7 @@ * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS,
