You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by pk...@apache.org on 2023/07/10 21:24:00 UTC
[logging-log4j2] 02/04: Eliminate toLowerCase and toUpperCase methods that are use constant Locale.
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 683082b1ad0d8ed5f9f8fc144eedfdcb07197362
Author: Ammar Y. Awad <am...@ejad.com.eg>
AuthorDate: Sun Jul 9 00:25:32 2023 +0300
Eliminate toLowerCase and toUpperCase methods that are use constant Locale.
---
.../src/main/java/org/apache/logging/log4j/Level.java | 17 +++++++----------
.../org/apache/logging/log4j/util/EnglishEnums.java | 5 +++--
.../core/async/AsyncQueueFullPolicyFactoryTest.java | 5 ++---
.../apache/logging/log4j/core/pattern/AnsiEscape.java | 7 ++++---
.../logging/log4j/core/pattern/HighlightConverter.java | 7 ++++---
.../logging/log4j/core/pattern/JAnsiTextRenderer.java | 4 ++--
.../log4j/core/pattern/LevelPatternConverter.java | 7 ++++---
.../logging/log4j/core/tools/picocli/CommandLine.java | 15 +++++++--------
.../apache/logging/log4j/core/util/CronExpression.java | 5 +++--
.../apache/logging/log4j/core/util/OptionConverter.java | 5 +++--
.../logging/log4j/flume/appender/FlumeAppender.java | 5 +++--
.../log4j/flume/appender/FlumeEmbeddedManager.java | 10 ++++------
12 files changed, 46 insertions(+), 46 deletions(-)
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/Level.java b/log4j-api/src/main/java/org/apache/logging/log4j/Level.java
index 1811f8edde..88eb7b9244 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/Level.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/Level.java
@@ -16,7 +16,6 @@
*/
package org.apache.logging.log4j;
-import java.util.Locale;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
@@ -24,6 +23,8 @@ import java.util.concurrent.ConcurrentMap;
import org.apache.logging.log4j.spi.StandardLevel;
import org.apache.logging.log4j.util.Strings;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
/**
* Levels used for identifying the severity of an event. Levels are organized from most specific to least:
* <table>
@@ -137,7 +138,7 @@ public final class Level implements Comparable<Level> {
this.name = name;
this.intLevel = intLevel;
this.standardLevel = StandardLevel.getStandardLevel(intLevel);
- if (LEVELS.putIfAbsent(toUpperCase(name.trim()), this) != null) {
+ if (LEVELS.putIfAbsent(toRootUpperCase(name.trim()), this) != null) {
throw new IllegalStateException("Level " + name + " has already been defined.");
}
}
@@ -260,7 +261,7 @@ public final class Level implements Comparable<Level> {
if (Strings.isEmpty(name)) {
throw new IllegalArgumentException("Illegal null or empty Level name.");
}
- final String normalizedName = toUpperCase(name.trim());
+ final String normalizedName = toRootUpperCase(name.trim());
final Level level = LEVELS.get(normalizedName);
if (level != null) {
return level;
@@ -285,7 +286,7 @@ public final class Level implements Comparable<Level> {
if (Strings.isEmpty(name)) {
throw new IllegalArgumentException("Illegal null or empty Level name.");
}
- return LEVELS.get(toUpperCase(name.trim()));
+ return LEVELS.get(toRootUpperCase(name.trim()));
}
/**
@@ -311,14 +312,10 @@ public final class Level implements Comparable<Level> {
if (name == null) {
return defaultLevel;
}
- final Level level = LEVELS.get(toUpperCase(name.trim()));
+ final Level level = LEVELS.get(toRootUpperCase(name.trim()));
return level == null ? defaultLevel : level;
}
- private static String toUpperCase(final String name) {
- return name.toUpperCase(Locale.ENGLISH);
- }
-
/**
* Return an array of all the Levels that have been registered.
*
@@ -338,7 +335,7 @@ public final class Level implements Comparable<Level> {
*/
public static Level valueOf(final String name) {
Objects.requireNonNull(name, "No level name given.");
- final String levelName = toUpperCase(name.trim());
+ final String levelName = toRootUpperCase(name.trim());
final Level level = LEVELS.get(levelName);
if (level != null) {
return level;
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java
index 645397a3ce..7b482da91a 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java
@@ -16,7 +16,8 @@
*/
package org.apache.logging.log4j.util;
-import java.util.Locale;
+
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
/**
* <em>Consider this class private.</em>
@@ -65,7 +66,7 @@ public final class EnglishEnums {
* @return an enum value or {@code defaultValue} if {@code name} is null.
*/
public static <T extends Enum<T>> T valueOf(final Class<T> enumType, final String name, final T defaultValue) {
- return name == null ? defaultValue : Enum.valueOf(enumType, name.toUpperCase(Locale.ENGLISH));
+ return name == null ? defaultValue : Enum.valueOf(enumType, toRootUpperCase(name));
}
}
diff --git a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactoryTest.java b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactoryTest.java
index 827506339f..79851ed91b 100644
--- a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactoryTest.java
+++ b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactoryTest.java
@@ -16,8 +16,6 @@
*/
package org.apache.logging.log4j.core.async;
-import java.util.Locale;
-
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.core.impl.Log4jPropertyKey;
import org.apache.logging.log4j.util.PropertiesUtil;
@@ -26,6 +24,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
+import static org.apache.logging.log4j.util.Strings.toRootLowerCase;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
@@ -74,7 +73,7 @@ public class AsyncQueueFullPolicyFactoryTest {
@Test
public void testCreateDiscardingRouterCaseInsensitive() {
System.setProperty(Log4jPropertyKey.ASYNC_LOGGER_QUEUE_FULL_POLICY.getKey(),
- AsyncQueueFullPolicyFactory.PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER.toLowerCase(Locale.ENGLISH));
+ toRootLowerCase(AsyncQueueFullPolicyFactory.PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER));
assertEquals(Level.INFO, ((DiscardingAsyncQueueFullPolicy) AsyncQueueFullPolicyFactory.create()).
getThresholdLevel());
}
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/AnsiEscape.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/AnsiEscape.java
index 7094afecc2..51e8c75b75 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/AnsiEscape.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/AnsiEscape.java
@@ -18,7 +18,6 @@ package org.apache.logging.log4j.core.pattern;
import java.util.Arrays;
import java.util.HashMap;
-import java.util.Locale;
import java.util.Map;
import org.apache.logging.log4j.core.util.Patterns;
@@ -26,6 +25,8 @@ import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.EnglishEnums;
import org.apache.logging.log4j.util.Strings;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
/**
* Converts text into ANSI escape sequences.
* <p>
@@ -426,7 +427,7 @@ public enum AnsiEscape {
for (final String string : values) {
final String[] keyValue = string.split(Patterns.toWhitespaceSeparator("="));
if (keyValue.length > 1) {
- final String key = keyValue[0].toUpperCase(Locale.ENGLISH);
+ final String key = toRootUpperCase(keyValue[0]);
final String value = keyValue[1];
final boolean escape = Arrays.binarySearch(sortedIgnoreKeys, key) < 0;
map.put(key, escape ? createSequence(value.split("\\s")) : value);
@@ -459,7 +460,7 @@ public enum AnsiEscape {
}
first = false;
String hexColor = null;
- final String trimmedName = name.trim().toUpperCase(Locale.ENGLISH);
+ final String trimmedName = toRootUpperCase(name.trim());
if (trimmedName.startsWith("#")) {
sb.append("38");
sb.append(SEPARATOR.getCode());
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/HighlightConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/HighlightConverter.java
index 7b09f37224..38c3b19590 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/HighlightConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/HighlightConverter.java
@@ -19,7 +19,6 @@ package org.apache.logging.log4j.core.pattern;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
-import java.util.Locale;
import java.util.Map;
import org.apache.logging.log4j.Level;
@@ -31,6 +30,8 @@ import org.apache.logging.log4j.plugins.Plugin;
import org.apache.logging.log4j.util.PerformanceSensitive;
import org.apache.logging.log4j.util.Strings;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
/**
* Highlight pattern converter. Formats the result of a pattern using a color appropriate for the Level in the LogEvent.
* <p>
@@ -151,10 +152,10 @@ public final class HighlightConverter extends LogEventPatternConverter implement
final Map<String, String> styles = AnsiEscape.createMap(string, new String[] {STYLE_KEY});
final Map<String, String> levelStyles = new HashMap<>(DEFAULT_STYLES);
for (final Map.Entry<String, String> entry : styles.entrySet()) {
- final String key = entry.getKey().toUpperCase(Locale.ENGLISH);
+ final String key = toRootUpperCase(entry.getKey());
final String value = entry.getValue();
if (STYLE_KEY.equalsIgnoreCase(key)) {
- final Map<String, String> enumMap = STYLES.get(value.toUpperCase(Locale.ENGLISH));
+ final Map<String, String> enumMap = STYLES.get(toRootUpperCase(value));
if (enumMap == null) {
LOGGER.error("Unknown level style: " + value + ". Use one of " +
Arrays.toString(STYLES.keySet().toArray()));
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiTextRenderer.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiTextRenderer.java
index 4a7a877e6d..d5d9fa25da 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiTextRenderer.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiTextRenderer.java
@@ -18,7 +18,6 @@ package org.apache.logging.log4j.core.pattern;
import java.util.Collections;
import java.util.HashMap;
-import java.util.Locale;
import java.util.Map;
import org.apache.logging.log4j.status.StatusLogger;
@@ -26,6 +25,7 @@ import org.fusesource.jansi.Ansi;
import org.fusesource.jansi.AnsiRenderer;
import org.fusesource.jansi.AnsiRenderer.Code;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
import static org.fusesource.jansi.AnsiRenderer.Code.BG_RED;
import static org.fusesource.jansi.AnsiRenderer.Code.BOLD;
import static org.fusesource.jansi.AnsiRenderer.Code.RED;
@@ -320,7 +320,7 @@ public final class JAnsiTextRenderer implements TextRenderer {
}
private Code toCode(final String name) {
- return Code.valueOf(name.toUpperCase(Locale.ENGLISH));
+ return Code.valueOf(toRootUpperCase(name));
}
@Override
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/LevelPatternConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/LevelPatternConverter.java
index a6e30c44b1..c331278f9d 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/LevelPatternConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/LevelPatternConverter.java
@@ -17,7 +17,6 @@
package org.apache.logging.log4j.core.pattern;
import java.util.HashMap;
-import java.util.Locale;
import java.util.Map;
import org.apache.logging.log4j.Level;
@@ -27,6 +26,8 @@ import org.apache.logging.log4j.plugins.Namespace;
import org.apache.logging.log4j.plugins.Plugin;
import org.apache.logging.log4j.util.PerformanceSensitive;
+import static org.apache.logging.log4j.util.Strings.toRootLowerCase;
+
/**
* Returns the event's level in a StringBuilder.
*/
@@ -93,7 +94,7 @@ public abstract class LevelPatternConverter extends LogEventPatternConverter {
for (final Level level : Level.values()) {
if (!levelMap.containsKey(level)) {
final String left = left(level, length);
- levelMap.put(level, lowerCase ? left.toLowerCase(Locale.US) : left);
+ levelMap.put(level, lowerCase ? toRootLowerCase(left) : left);
}
}
return new LevelMapLevelPatternConverter(levelMap);
@@ -131,7 +132,7 @@ public abstract class LevelPatternConverter extends LogEventPatternConverter {
@Override
public String getStyleClass(final Object e) {
if (e instanceof LogEvent) {
- return "level " + ((LogEvent) e).getLevel().name().toLowerCase(Locale.ENGLISH);
+ return "level " + toRootLowerCase(((LogEvent) e).getLevel().name());
}
return "level";
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java
index 241471c0f1..42ed01290b 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java
@@ -68,11 +68,10 @@ import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.IStyle;
import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Style;
import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text;
-import static java.util.Locale.ENGLISH;
-
import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.SPAN;
import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.TRUNCATE;
import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.WRAP;
+import static org.apache.logging.log4j.util.Strings.toRootLowerCase;
import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
/**
@@ -4359,8 +4358,8 @@ public class CommandLine {
* @return the IStyle for the specified converter
*/
public static IStyle fg(final String str) {
- try { return Style.valueOf(str.toLowerCase(ENGLISH)); } catch (final Exception ignored) {}
- try { return Style.valueOf("fg_" + str.toLowerCase(ENGLISH)); } catch (final Exception ignored) {}
+ try { return Style.valueOf(toRootLowerCase(str)); } catch (final Exception ignored) {}
+ try { return Style.valueOf("fg_" + toRootLowerCase(str)); } catch (final Exception ignored) {}
return new Palette256Color(true, str);
}
/** Parses the specified style markup and returns the associated style.
@@ -4371,8 +4370,8 @@ public class CommandLine {
* @return the IStyle for the specified converter
*/
public static IStyle bg(final String str) {
- try { return Style.valueOf(str.toLowerCase(ENGLISH)); } catch (final Exception ignored) {}
- try { return Style.valueOf("bg_" + str.toLowerCase(ENGLISH)); } catch (final Exception ignored) {}
+ try { return Style.valueOf(toRootLowerCase(str)); } catch (final Exception ignored) {}
+ try { return Style.valueOf("bg_" + toRootLowerCase(str)); } catch (final Exception ignored) {}
return new Palette256Color(false, str);
}
/** Parses the specified comma-separated sequence of style descriptors and returns the associated
@@ -4385,10 +4384,10 @@ public class CommandLine {
final String[] codes = commaSeparatedCodes.split(",");
final IStyle[] styles = new IStyle[codes.length];
for(int i = 0; i < codes.length; ++i) {
- if (codes[i].toLowerCase(ENGLISH).startsWith("fg(")) {
+ if (toRootLowerCase(codes[i]).startsWith("fg(")) {
final int end = codes[i].indexOf(')');
styles[i] = Style.fg(codes[i].substring(3, end < 0 ? codes[i].length() : end));
- } else if (codes[i].toLowerCase(ENGLISH).startsWith("bg(")) {
+ } else if (toRootLowerCase(codes[i]).startsWith("bg(")) {
final int end = codes[i].indexOf(')');
styles[i] = Style.bg(codes[i].substring(3, end < 0 ? codes[i].length() : end));
} else {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
index 657987d43d..9802b1de28 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
@@ -26,13 +26,14 @@ import java.util.Calendar;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
-import java.util.Locale;
import java.util.Map;
import java.util.SortedSet;
import java.util.StringTokenizer;
import java.util.TimeZone;
import java.util.TreeSet;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
/**
* Provides a parser and evaluator for unix-like cron expressions. Cron
* expressions provide the ability to specify complex time combinations such as
@@ -272,7 +273,7 @@ public final class CronExpression {
throw new IllegalArgumentException("cronExpression cannot be null");
}
- this.cronExpression = cronExpression.toUpperCase(Locale.US);
+ this.cronExpression = toRootUpperCase(cronExpression);
buildExpression(this.cronExpression);
}
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/OptionConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/OptionConverter.java
index 944cc9157e..8339b12f6f 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/OptionConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/OptionConverter.java
@@ -19,7 +19,6 @@ package org.apache.logging.log4j.core.util;
import java.io.InterruptedIOException;
import java.util.ArrayList;
import java.util.List;
-import java.util.Locale;
import java.util.Properties;
import org.apache.logging.log4j.Level;
@@ -28,6 +27,8 @@ import org.apache.logging.log4j.status.StatusLogger;
import org.apache.logging.log4j.util.PropertiesUtil;
import org.apache.logging.log4j.util.Strings;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
/**
* A convenience class to convert property values to specific types.
*/
@@ -234,7 +235,7 @@ public final class OptionConverter {
return defaultValue;
}
- String str = value.trim().toUpperCase(Locale.ENGLISH);
+ String str = toRootUpperCase(value.trim());
long multiplier = 1;
int index;
diff --git a/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeAppender.java b/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeAppender.java
index e301afe2e4..8192e342a0 100644
--- a/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeAppender.java
+++ b/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeAppender.java
@@ -16,7 +16,6 @@
*/
package org.apache.logging.log4j.flume.appender;
-import java.util.Locale;
import java.util.concurrent.TimeUnit;
import org.apache.logging.log4j.core.Appender;
@@ -38,6 +37,8 @@ import org.apache.logging.log4j.plugins.PluginFactory;
import org.apache.logging.log4j.plugins.di.Injector;
import org.apache.logging.log4j.util.Timer;
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
/**
* An Appender that uses the Avro protocol to route events to Flume.
*/
@@ -74,7 +75,7 @@ public final class FlumeAppender extends AbstractAppender implements FlumeEventF
AVRO, EMBEDDED, PERSISTENT;
public static ManagerType getType(final String type) {
- return valueOf(type.toUpperCase(Locale.US));
+ return valueOf(toRootUpperCase(type));
}
}
diff --git a/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEmbeddedManager.java b/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEmbeddedManager.java
index fe798b52d7..ba4138b8fe 100644
--- a/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEmbeddedManager.java
+++ b/log4j-flume-ng/src/main/java/org/apache/logging/log4j/flume/appender/FlumeEmbeddedManager.java
@@ -17,7 +17,6 @@
package org.apache.logging.log4j.flume.appender;
import java.util.HashMap;
-import java.util.Locale;
import java.util.Map;
import java.util.concurrent.TimeUnit;
@@ -32,9 +31,8 @@ import org.apache.logging.log4j.util.NameUtil;
import org.apache.logging.log4j.util.PropertiesUtil;
import org.apache.logging.log4j.util.Strings;
-/**
- *
- */
+import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
+
public class FlumeEmbeddedManager extends AbstractFlumeManager {
private static final String FILE_SEP = PropertiesUtil.getProperties().getStringProperty("file.separator");
@@ -253,9 +251,9 @@ public class FlumeEmbeddedManager extends AbstractFlumeManager {
throw new ConfigurationException(msg);
}
- final String upperKey = key.toUpperCase(Locale.ENGLISH);
+ final String upperKey = toRootUpperCase(key);
- if (upperKey.startsWith(name.toUpperCase(Locale.ENGLISH))) {
+ if (upperKey.startsWith(toRootUpperCase(name))) {
final String msg =
"Specification of the agent name is not allowed in Flume Appender configuration: " + key;
LOGGER.error(msg);