Rename groupId and packages from o.a.l.log4j.tools to o.a.l.log4j

vy · vy · commit c79f69fedc72 · 2023-01-05T09:18:37.000+01:00
diff --git a/log4j-changelog/README.adoc b/log4j-changelog/README.adoc
@@ -194,7 +194,7 @@ Each `.changelog.adoc.ftl` FreeMarker templated AsciiDoc files are compiled by `
 * `release` -> `ChangelogRelease`
 * `entriesByType` -> `Map<ChangelogEntry.Type, List<ChangelogEntry>>`
 
-See xref:src/main/java/org/apache/logging/log4j/tools/changelog/ChangelogRelease.java[ChangelogRelease.java] and xref:src/main/java/org/apache/logging/log4j/tools/changelog/ChangelogEntry.java[ChangelogEntry.java] for details.
+See xref:src/main/java/org/apache/logging/log4j/changelog/ChangelogRelease.java[ChangelogRelease.java] and xref:src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java[ChangelogEntry.java] for details.
 
 A sample changelog template file is shared below.
 
@@ -261,7 +261,7 @@ java \
     -cp /path/to/log4j-changelog.jar \
     -Dlog4j.changelog.directory=/path/to/changelog/directory \
     -Dlog4j.changelog.exporter.outputDirectory=/path/to/asciiDocOutputDirectory \
-    org.apache.logging.log4j.tools.changelog.exporter.ChangelogExporter
+    org.apache.logging.log4j.changelog.exporter.ChangelogExporter
 ----
 
 [#qa-deploy-release]
@@ -294,7 +294,7 @@ java \
     -cp /path/to/log4j-changelog.jar \
     -Dlog4j.changelog.directory=/path/to/changelog/directory \
     -Dlog4j.changelog.releaseVersion=X.Y.Z \
-    org.apache.logging.log4j.tools.changelog.releaser.ChangelogReleaser
+    org.apache.logging.log4j.changelog.releaser.ChangelogReleaser
 ----
 . Verify that all changelog entry files are moved from `<changelogDirectory>/.<releaseVersionMajor>.x.x` directory (e.g., `/src/changelog/.2.x.x`)
 . Verify that `<changelogDirectory>/<releaseVersion>` directory (e.g., `/src/changelog/2.19.0`) is created, and it contains `.changelog.adoc.ftl`, `.release.xml`, and changelog entry files
diff --git a/log4j-changelog/pom.xml b/log4j-changelog/pom.xml
@@ -23,7 +23,7 @@
 
   <parent>
     <artifactId>log4j-tools-parent</artifactId>
-    <groupId>org.apache.logging.log4j.tools</groupId>
+    <groupId>org.apache.logging.log4j</groupId>
     <version>${revision}</version>
     <relativePath>../log4j-tools-parent/pom.xml</relativePath>
   </parent>
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java
@@ -14,20 +14,19 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog;
+package org.apache.logging.log4j.changelog;
 
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Locale;
 import java.util.stream.Collectors;
 
-import org.apache.logging.log4j.tools.XmlReader;
-import org.apache.logging.log4j.tools.XmlWriter;
+import org.apache.logging.log4j.changelog.util.StringUtils;
+import org.apache.logging.log4j.changelog.util.XmlReader;
+import org.apache.logging.log4j.changelog.util.XmlWriter;
 
 import org.w3c.dom.Element;
 
-import static org.apache.logging.log4j.tools.StringUtils.trimNullable;
-
 public final class ChangelogEntry {
 
     public final Type type;
@@ -197,7 +196,7 @@ public static ChangelogEntry readFromXmlFile(final Path path) {
         // Read the `description` element.
         final Element descriptionElement = XmlReader.requireChildElementMatchingName(entryElement, "description");
         final String descriptionFormat = XmlReader.requireAttribute(descriptionElement, "format");
-        final String descriptionText = trimNullable(descriptionElement.getTextContent());
+        final String descriptionText = StringUtils.trimNullable(descriptionElement.getTextContent());
         final Description description = new Description(descriptionFormat, descriptionText);
 
         // Create the instance.
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogFiles.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogFiles.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog;
+package org.apache.logging.log4j.changelog;
 
 import java.nio.file.Path;
 import java.util.Set;
@@ -23,7 +23,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.apache.logging.log4j.tools.FileUtils;
+import org.apache.logging.log4j.changelog.util.FileUtils;
 
 public final class ChangelogFiles {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogRelease.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogRelease.java
@@ -14,17 +14,16 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog;
+package org.apache.logging.log4j.changelog;
 
 import java.nio.file.Path;
 
-import org.apache.logging.log4j.tools.XmlReader;
-import org.apache.logging.log4j.tools.XmlWriter;
+import org.apache.logging.log4j.changelog.util.StringUtils;
+import org.apache.logging.log4j.changelog.util.XmlReader;
+import org.apache.logging.log4j.changelog.util.XmlWriter;
 
 import org.w3c.dom.Element;
 
-import static org.apache.logging.log4j.tools.StringUtils.trimNullable;
-
 public final class ChangelogRelease {
 
     public final String version;
@@ -51,13 +50,13 @@ public static ChangelogRelease readFromXmlFile(final Path path) {
         final Element releaseElement = XmlReader.readXmlFileRootElement(path, "release");
 
         // Read the `version` attribute.
-        final String version = trimNullable(releaseElement.getAttribute("version"));
+        final String version = StringUtils.trimNullable(releaseElement.getAttribute("version"));
         if (version == null) {
             throw new IllegalArgumentException("blank or missing attribute: `version`");
         }
 
         // Read the `date` attribute.
-        final String date = trimNullable(releaseElement.getAttribute("date"));
+        final String date = StringUtils.trimNullable(releaseElement.getAttribute("date"));
         if (date == null) {
             throw new IllegalArgumentException("blank or missing attribute: `date`");
         }
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporter.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporter.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.exporter;
+package org.apache.logging.log4j.changelog.exporter;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
@@ -23,10 +23,10 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
-import org.apache.logging.log4j.tools.FileUtils;
-import org.apache.logging.log4j.tools.changelog.ChangelogEntry;
-import org.apache.logging.log4j.tools.changelog.ChangelogFiles;
-import org.apache.logging.log4j.tools.changelog.ChangelogRelease;
+import org.apache.logging.log4j.changelog.ChangelogEntry;
+import org.apache.logging.log4j.changelog.ChangelogFiles;
+import org.apache.logging.log4j.changelog.ChangelogRelease;
+import org.apache.logging.log4j.changelog.util.FileUtils;
 
 public final class ChangelogExporter {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporterArgs.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/ChangelogExporterArgs.java
@@ -14,11 +14,11 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.exporter;
+package org.apache.logging.log4j.changelog.exporter;
 
 import java.nio.file.Path;
 
-import static org.apache.logging.log4j.tools.PropertyUtils.requireNonBlankPathProperty;
+import static org.apache.logging.log4j.changelog.util.PropertyUtils.requireNonBlankPathProperty;
 
 final class ChangelogExporterArgs {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/FreeMarkerUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/exporter/FreeMarkerUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.exporter;
+package org.apache.logging.log4j.changelog.exporter;
 
 import java.io.BufferedWriter;
 import java.io.File;
@@ -24,7 +24,7 @@
 import java.nio.file.Path;
 import java.nio.file.StandardOpenOption;
 
-import org.apache.logging.log4j.tools.CharsetUtils;
+import org.apache.logging.log4j.changelog.util.CharsetUtils;
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import freemarker.cache.FileTemplateLoader;
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/importer/MavenChanges.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/importer/MavenChanges.java
@@ -14,23 +14,23 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.importer;
+package org.apache.logging.log4j.changelog.importer;
 
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
 
-import org.apache.logging.log4j.tools.XmlReader;
+import org.apache.logging.log4j.changelog.util.XmlReader;
 
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
-import static org.apache.logging.log4j.tools.StringUtils.isBlank;
-import static org.apache.logging.log4j.tools.StringUtils.trimNullable;
-import static org.apache.logging.log4j.tools.XmlReader.failureAtXmlNode;
-import static org.apache.logging.log4j.tools.XmlReader.readXmlFileRootElement;
+import static org.apache.logging.log4j.changelog.util.StringUtils.isBlank;
+import static org.apache.logging.log4j.changelog.util.StringUtils.trimNullable;
+import static org.apache.logging.log4j.changelog.util.XmlReader.failureAtXmlNode;
+import static org.apache.logging.log4j.changelog.util.XmlReader.readXmlFileRootElement;
 
 final class MavenChanges {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/importer/MavenChangesImporter.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/importer/MavenChangesImporter.java
@@ -14,17 +14,17 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.importer;
+package org.apache.logging.log4j.changelog.importer;
 
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
 
-import org.apache.logging.log4j.tools.changelog.ChangelogEntry;
-import org.apache.logging.log4j.tools.changelog.ChangelogFiles;
-import org.apache.logging.log4j.tools.changelog.ChangelogRelease;
+import org.apache.logging.log4j.changelog.ChangelogEntry;
+import org.apache.logging.log4j.changelog.ChangelogFiles;
+import org.apache.logging.log4j.changelog.ChangelogRelease;
 
-import static org.apache.logging.log4j.tools.StringUtils.isBlank;
+import static org.apache.logging.log4j.changelog.util.StringUtils.isBlank;
 
 public final class MavenChangesImporter {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/importer/MavenChangesImporterArgs.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/importer/MavenChangesImporterArgs.java
@@ -14,12 +14,12 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.importer;
+package org.apache.logging.log4j.changelog.importer;
 
 import java.nio.file.Path;
 
-import static org.apache.logging.log4j.tools.PropertyUtils.requireNonBlankIntProperty;
-import static org.apache.logging.log4j.tools.PropertyUtils.requireNonBlankPathProperty;
+import static org.apache.logging.log4j.changelog.util.PropertyUtils.requireNonBlankIntProperty;
+import static org.apache.logging.log4j.changelog.util.PropertyUtils.requireNonBlankPathProperty;
 
 final class MavenChangesImporterArgs {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/releaser/ChangelogReleaser.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/releaser/ChangelogReleaser.java
@@ -14,23 +14,21 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.releaser;
+package org.apache.logging.log4j.changelog.releaser;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.time.LocalDate;
 
-import org.apache.logging.log4j.tools.FileUtils;
-import org.apache.logging.log4j.tools.VersionUtils;
-import org.apache.logging.log4j.tools.changelog.ChangelogFiles;
-import org.apache.logging.log4j.tools.changelog.ChangelogRelease;
+import org.apache.logging.log4j.changelog.ChangelogFiles;
+import org.apache.logging.log4j.changelog.ChangelogRelease;
+import org.apache.logging.log4j.changelog.util.FileUtils;
+import org.apache.logging.log4j.changelog.util.VersionUtils;
 
 import static java.time.format.DateTimeFormatter.ISO_DATE;
 
-import static org.apache.logging.log4j.tools.changelog.ChangelogFiles.releaseDirectory;
-
 public final class ChangelogReleaser {
 
     private ChangelogReleaser() {}
@@ -47,7 +45,7 @@ public static void main(final String[] mainArgs) throws Exception {
 
         // Populate the changelog entry files in the release directory.
         final Path unreleasedDirectory = ChangelogFiles.unreleasedDirectory(args.changelogDirectory, releaseVersionMajor);
-        final Path releaseDirectory = releaseDirectory(args.changelogDirectory, args.releaseVersion);
+        final Path releaseDirectory = ChangelogFiles.releaseDirectory(args.changelogDirectory, args.releaseVersion);
         populateChangelogEntryFiles(unreleasedDirectory, releaseDirectory);
 
         // Write the release information.
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/releaser/ChangelogReleaserArgs.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/releaser/ChangelogReleaserArgs.java
@@ -14,13 +14,13 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools.changelog.releaser;
+package org.apache.logging.log4j.changelog.releaser;
 
 import java.nio.file.Path;
 
-import static org.apache.logging.log4j.tools.PropertyUtils.requireNonBlankPathProperty;
-import static org.apache.logging.log4j.tools.PropertyUtils.requireNonBlankStringProperty;
-import static org.apache.logging.log4j.tools.VersionUtils.requireSemanticVersioning;
+import static org.apache.logging.log4j.changelog.util.PropertyUtils.requireNonBlankPathProperty;
+import static org.apache.logging.log4j.changelog.util.PropertyUtils.requireNonBlankStringProperty;
+import static org.apache.logging.log4j.changelog.util.VersionUtils.requireSemanticVersioning;
 
 final class ChangelogReleaserArgs {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/AsciiDocUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/AsciiDocUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 public final class AsciiDocUtils {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/CharsetUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/CharsetUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/FileUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/FileUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/PositionalSaxEventHandler.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/PositionalSaxEventHandler.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 import java.util.Stack;
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/PropertyUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/PropertyUtils.java
@@ -14,13 +14,13 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 import java.nio.file.InvalidPathException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
-import static org.apache.logging.log4j.tools.StringUtils.isBlank;
+import static org.apache.logging.log4j.changelog.util.StringUtils.isBlank;
 
 public final class PropertyUtils {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/StringUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/StringUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 public final class StringUtils {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/VersionUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/VersionUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 public final class VersionUtils {
 
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/XmlReader.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/XmlReader.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 import java.io.FileInputStream;
 import java.io.InputStream;
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/XmlUtils.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/XmlUtils.java
@@ -14,7 +14,7 @@
  * See the license for the specific language governing permissions and
  * limitations under the license.
  */
-package org.apache.logging.log4j.tools;
+package org.apache.logging.log4j.changelog.util;
 
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/XmlWriter.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/util/XmlWriter.java
diff --git a/log4j-tools-parent/pom.xml b/log4j-tools-parent/pom.xml
diff --git a/pom.xml b/pom.xml
