(logging-log4j2) branch 2.x updated: Uniformize API of `StackLocator` versions (#3340)

[pkarwasz]

This is an automated email from the ASF dual-hosted git repository.

pkarwasz pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/2.x by this push:
     new cb46e63cff Uniformize API of `StackLocator` versions (#3340)
cb46e63cff is described below

commit cb46e63cff177df5cde45bfeb02f8580178308b9
Author: Piotr P. Karwasz <piotr.git...@karwasz.org>
AuthorDate: Mon Dec 30 09:28:39 2024 +0100

    Uniformize API of `StackLocator` versions (#3340)
    
    The Java 9 version of `StackLocator` has an additional public 
`getCallerClass(String)` method. This method makes the Java 8 and 9 versions of 
`StackLocator` expose different APIs to the user. To prevent API compatibility 
problems, we remove the additional method.
    
    This incompatibility was accidentally discovered during the work in #3339: 
`japicmp` did randomly compare a `StackLocator` class from the old version with 
a `StackLocator` class from the new version.
    
    This is part of #1867.
---
 .../src/main/java/org/apache/logging/log4j/util/StackLocator.java     | 4 ----
 .../java/org/apache/logging/log4j/util/java9/StackLocatorTest.java    | 2 +-
 2 files changed, 1 insertion(+), 5 deletions(-)

diff --git 
a/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/StackLocator.java 
b/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/StackLocator.java
index f8915071da..e928777ed6 100644
--- 
a/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/StackLocator.java
+++ 
b/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/StackLocator.java
@@ -53,10 +53,6 @@ public final class StackLocator {
                 .orElse(null));
     }
 
-    public Class<?> getCallerClass(final String fqcn) {
-        return getCallerClass(fqcn, "");
-    }
-
     public Class<?> getCallerClass(final String fqcn, final String pkg) {
         return WALKER.walk(s -> s.dropWhile(f -> 
!f.getClassName().equals(fqcn))
                         .dropWhile(f -> f.getClassName().equals(fqcn))
diff --git 
a/log4j-api-java9/src/test/java/org/apache/logging/log4j/util/java9/StackLocatorTest.java
 
b/log4j-api-java9/src/test/java/org/apache/logging/log4j/util/java9/StackLocatorTest.java
index 2ccebbde0f..cc8f61218a 100644
--- 
a/log4j-api-java9/src/test/java/org/apache/logging/log4j/util/java9/StackLocatorTest.java
+++ 
b/log4j-api-java9/src/test/java/org/apache/logging/log4j/util/java9/StackLocatorTest.java
@@ -73,7 +73,7 @@ class StackLocatorTest {
         private static void assertCallerClassViaName() {
             final Class<?> expected = StackLocatorTest.class;
             final StackLocator stackLocator = StackLocator.getInstance();
-            final Class<?> actual = 
stackLocator.getCallerClass(Inner.class.getName());
+            final Class<?> actual = 
stackLocator.getCallerClass(Inner.class.getName(), "");
             assertSame(expected, actual);
         }