You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2021/06/24 15:23:04 UTC

[logging-log4j2] branch master updated: Make Local variable and parameter final. (#524)

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

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


The following commit(s) were added to refs/heads/master by this push:
     new b9d8a83  Make Local variable and parameter final. (#524)
b9d8a83 is described below

commit b9d8a83f1cbf5d30157d484e682b4fcdb1fec096
Author: Arturo Bernal <ar...@gmail.com>
AuthorDate: Thu Jun 24 17:22:56 2021 +0200

    Make Local variable and parameter final. (#524)
---
 .../layout/template/json/JsonTemplateLayout.java     |  6 +++---
 .../json/resolver/CaseConverterResolver.java         |  8 ++++----
 .../template/json/resolver/EventResolverContext.java |  2 +-
 .../json/resolver/EventRootObjectKeyInterceptor.java |  2 +-
 .../template/json/resolver/ExceptionResolver.java    |  4 ++--
 .../template/json/resolver/TemplateResolver.java     |  4 ++--
 .../json/resolver/TemplateResolverContext.java       |  2 +-
 .../json/resolver/TemplateResolverInterceptor.java   |  2 +-
 .../template/json/resolver/TemplateResolvers.java    |  4 ++--
 .../template/json/resolver/TimestampResolver.java    |  2 +-
 .../log4j/layout/template/json/util/JsonReader.java  | 20 ++++++++++----------
 .../log4j/layout/template/json/util/JsonWriter.java  |  2 +-
 .../layout/template/json/util/RecyclerFactories.java |  2 +-
 .../layout/template/json/util/RecyclerFactory.java   |  2 +-
 .../template/json/util/StringParameterParser.java    | 12 ++++++------
 15 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayout.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayout.java
index 214661e..fc4548e 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayout.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayout.java
@@ -420,7 +420,7 @@ public class JsonTemplateLayout implements StringLayout {
             return eventTemplateRootObjectKey;
         }
 
-        public Builder setEventTemplateRootObjectKey(String eventTemplateRootObjectKey) {
+        public Builder setEventTemplateRootObjectKey(final String eventTemplateRootObjectKey) {
             this.eventTemplateRootObjectKey = eventTemplateRootObjectKey;
             return this;
         }
@@ -562,14 +562,14 @@ public class JsonTemplateLayout implements StringLayout {
         }
 
         @Override
-        public boolean equals(Object object) {
+        public boolean equals(final Object object) {
             if (this == object) {
                 return true;
             }
             if (object == null || getClass() != object.getClass()) {
                 return false;
             }
-            EventTemplateAdditionalField that = (EventTemplateAdditionalField) object;
+            final EventTemplateAdditionalField that = (EventTemplateAdditionalField) object;
             return key.equals(that.key) &&
                     value.equals(that.value) &&
                     format == that.format;
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/CaseConverterResolver.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/CaseConverterResolver.java
index a8e09be..5210384 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/CaseConverterResolver.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/CaseConverterResolver.java
@@ -153,7 +153,7 @@ public final class CaseConverterResolver implements EventResolver {
 
         private final String name;
 
-        ErrorHandlingStrategy(String name) {
+        ErrorHandlingStrategy(final String name) {
             this.name = name;
         }
 
@@ -171,7 +171,7 @@ public final class CaseConverterResolver implements EventResolver {
     private static TemplateResolver<LogEvent> createDelegate(
             final EventResolverContext context,
             final TemplateResolverConfig config) {
-        Object delegateObject = config.getObject("input");
+        final Object delegateObject = config.getObject("input");
         return TemplateResolvers.ofObject(context, delegateObject);
     }
 
@@ -194,7 +194,7 @@ public final class CaseConverterResolver implements EventResolver {
         if (strategyName == null) {
             return ErrorHandlingStrategy.REPLACE;
         }
-        for (ErrorHandlingStrategy strategy : ErrorHandlingStrategy.values()) {
+        for (final ErrorHandlingStrategy strategy : ErrorHandlingStrategy.values()) {
             if (strategy.name.equals(strategyName)) {
                 return strategy;
             }
@@ -206,7 +206,7 @@ public final class CaseConverterResolver implements EventResolver {
     private static TemplateResolver<LogEvent> createReplacement(
             final EventResolverContext context,
             final TemplateResolverConfig config) {
-        Object replacementObject = config.getObject("replacement");
+        final Object replacementObject = config.getObject("replacement");
         return TemplateResolvers.ofObject(context, replacementObject);
     }
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventResolverContext.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventResolverContext.java
index 8ec2317..d7a5793 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventResolverContext.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventResolverContext.java
@@ -246,7 +246,7 @@ public final class EventResolverContext implements TemplateResolverContext<LogEv
             return this;
         }
 
-        public Builder setEventTemplateRootObjectKey(String eventTemplateRootObjectKey) {
+        public Builder setEventTemplateRootObjectKey(final String eventTemplateRootObjectKey) {
             this.eventTemplateRootObjectKey = eventTemplateRootObjectKey;
             return this;
         }
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventRootObjectKeyInterceptor.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventRootObjectKeyInterceptor.java
index 688a3a1..35235b7 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventRootObjectKeyInterceptor.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/EventRootObjectKeyInterceptor.java
@@ -44,7 +44,7 @@ public class EventRootObjectKeyInterceptor implements EventResolverInterceptor {
     public Object processTemplateBeforeResolverInjection(
             final EventResolverContext context,
             final Object node) {
-        String eventTemplateRootObjectKey = context.getEventTemplateRootObjectKey();
+        final String eventTemplateRootObjectKey = context.getEventTemplateRootObjectKey();
         return eventTemplateRootObjectKey != null
                 ? Collections.singletonMap(eventTemplateRootObjectKey, node)
                 : node;
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/ExceptionResolver.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/ExceptionResolver.java
index e2a538a..3aa2774 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/ExceptionResolver.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/ExceptionResolver.java
@@ -223,7 +223,7 @@ public class ExceptionResolver implements EventResolver {
             if (exception == null) {
                 jsonWriter.writeNull();
             } else {
-                String exceptionClassName = exception.getClass().getCanonicalName();
+                final String exceptionClassName = exception.getClass().getCanonicalName();
                 jsonWriter.writeString(exceptionClassName);
             }
         };
@@ -235,7 +235,7 @@ public class ExceptionResolver implements EventResolver {
             if (exception == null) {
                 jsonWriter.writeNull();
             } else {
-                String exceptionMessage = exception.getMessage();
+                final String exceptionMessage = exception.getMessage();
                 jsonWriter.writeString(exceptionMessage);
             }
         };
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolver.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolver.java
index 62ce41d..b7d0d00 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolver.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolver.java
@@ -48,7 +48,7 @@ public interface TemplateResolver<V> {
      * For instance, the stack trace resolver can be short-circuited using this
      * check if the stack traces are disabled in the layout configuration.
      */
-    default boolean isResolvable(V value) {
+    default boolean isResolvable(final V value) {
         return true;
     }
 
@@ -62,7 +62,7 @@ public interface TemplateResolver<V> {
      *
      * @param succeedingEntry false, if this is the first element in a collection; true, otherwise
      */
-    default void resolve(V value, JsonWriter jsonWriter, boolean succeedingEntry) {
+    default void resolve(final V value, final JsonWriter jsonWriter, final boolean succeedingEntry) {
         resolve(value, jsonWriter);
     }
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverContext.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverContext.java
index 7f8cbb8..6c97200 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverContext.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverContext.java
@@ -53,7 +53,7 @@ interface TemplateResolverContext<V, C extends TemplateResolverContext<V, C>> {
      * @param node the root object of the read template
      * @return the root object of the template to be compiled
      */
-    default Object processTemplateBeforeResolverInjection(Object node) {
+    default Object processTemplateBeforeResolverInjection(final Object node) {
         return node;
     }
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverInterceptor.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverInterceptor.java
index 4989521..0183aa9 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverInterceptor.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolverInterceptor.java
@@ -49,7 +49,7 @@ public interface TemplateResolverInterceptor<V, C extends TemplateResolverContex
      * @param node the root object of the read template
      * @return the root object of the template to be compiled
      */
-    default Object processTemplateBeforeResolverInjection(C context, Object node) {
+    default Object processTemplateBeforeResolverInjection(final C context, final Object node) {
         return node;
     }
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolvers.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolvers.java
index 20ad802..7390091 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolvers.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TemplateResolvers.java
@@ -43,7 +43,7 @@ public final class TemplateResolvers {
         }
 
         @Override
-        public final boolean isResolvable(Object value) {
+        public final boolean isResolvable(final Object value) {
             return false;
         }
 
@@ -217,7 +217,7 @@ public final class TemplateResolvers {
         final List<String> fieldPrefixes = fieldNames
                 .stream()
                 .map(fieldName -> {
-                    try (JsonWriter jsonWriter = context.getJsonWriter()) {
+                    try (final JsonWriter jsonWriter = context.getJsonWriter()) {
                         jsonWriter.writeString(fieldName);
                         jsonWriter.getStringBuilder().append(':');
                         return jsonWriter.getStringBuilder().toString();
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TimestampResolver.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TimestampResolver.java
index 0b70d15..c6fdb46 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TimestampResolver.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/resolver/TimestampResolver.java
@@ -463,7 +463,7 @@ public final class TimestampResolver implements EventResolver {
                 }
             };
 
-    private static long epochNanos(Instant instant) {
+    private static long epochNanos(final Instant instant) {
         return 1_000_000_000L * instant.getEpochSecond() + instant.getNanoOfSecond();
     }
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonReader.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonReader.java
index c1377f7..175eeba 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonReader.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonReader.java
@@ -69,7 +69,7 @@ public final class JsonReader {
         }
 
         private static boolean exists(final Object token) {
-            for (Delimiter delimiter : values()) {
+            for (final Delimiter delimiter : values()) {
                 if (delimiter.string.equals(token)) {
                     return true;
                 }
@@ -174,7 +174,7 @@ public final class JsonReader {
                 if (Character.isDigit(readChar) || readChar == '-') {
                     readToken = readNumber();
                 } else {
-                    String message = String.format(
+                    final String message = String.format(
                             "invalid character at index %d: %c",
                             readCharIndex, readChar);
                     throw new IllegalArgumentException(message);
@@ -286,12 +286,12 @@ public final class JsonReader {
         while (readToken != Delimiter.OBJECT_END) {
             expectDelimiter(Delimiter.COLON, readToken());
             if (readToken != Delimiter.OBJECT_END) {
-                Object value = readToken();
+                final Object value = readToken();
                 object.put(key, value);
                 if (readToken() == Delimiter.COMMA) {
                     key = readObjectKey();
                     if (key == null || Delimiter.exists(key)) {
-                        String message = String.format(
+                        final String message = String.format(
                                 "was expecting an object key at index %d: %s",
                                 readTokenStartIndex, readToken);
                         throw new IllegalArgumentException(message);
@@ -348,7 +348,7 @@ public final class JsonReader {
             final Delimiter expectedDelimiter,
             final Object actualToken) {
         if (!expectedDelimiter.equals(actualToken)) {
-            String message = String.format(
+            final String message = String.format(
                     "was expecting %s at index %d: %s",
                     expectedDelimiter, readTokenStartIndex, actualToken);
             throw new IllegalArgumentException(message);
@@ -357,7 +357,7 @@ public final class JsonReader {
 
     private boolean readTrue() {
         if (readChar != 'r' || readChar() != 'u' || readChar() != 'e') {
-            String message = String.format(
+            final String message = String.format(
                     "was expecting keyword 'true' at index %d: %s",
                     readCharIndex, readChar);
             throw new IllegalArgumentException(message);
@@ -368,7 +368,7 @@ public final class JsonReader {
 
     private boolean readFalse() {
         if (readChar != 'a' || readChar() != 'l' || readChar() != 's' || readChar() != 'e') {
-            String message = String.format(
+            final String message = String.format(
                     "was expecting keyword 'false' at index %d: %s",
                     readCharIndex, readChar);
             throw new IllegalArgumentException(message);
@@ -379,7 +379,7 @@ public final class JsonReader {
 
     private Object readNull() {
         if (readChar != 'u' || readChar() != 'l' || readChar() != 'l') {
-            String message = String.format(
+            final String message = String.format(
                     "was expecting keyword 'null' at index %d: %s",
                     readCharIndex, readChar);
             throw new IllegalArgumentException(message);
@@ -423,10 +423,10 @@ public final class JsonReader {
             final BigInteger bigInteger = new BigInteger(string);
             try {
                 return bigInteger.intValueExact();
-            } catch (ArithmeticException ignoredIntOverflow) {
+            } catch (final ArithmeticException ignoredIntOverflow) {
                 try {
                     return bigInteger.longValueExact();
-                } catch (ArithmeticException ignoredLongOverflow) {
+                } catch (final ArithmeticException ignoredLongOverflow) {
                     return bigInteger;
                 }
             }
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonWriter.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonWriter.java
index 24c8f57..086f966 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonWriter.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/JsonWriter.java
@@ -68,7 +68,7 @@ public final class JsonWriter implements AutoCloseable, Cloneable {
      */
     private final static int[] ESC_CODES;
     static {
-        int[] table = new int[128];
+        final int[] table = new int[128];
         // Control chars need generic escape sequence
         for (int i = 0; i < 32; ++i) {
             // 04-Mar-2011, tatu: Used to use "-(i + 1)", replaced with constant
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactories.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactories.java
index 581af39..bbd724e 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactories.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactories.java
@@ -56,7 +56,7 @@ public final class RecyclerFactories {
     public static RecyclerFactory ofSpec(final String recyclerFactorySpec) {
 
         // Determine the default capacity.
-        int defaultCapacity = Math.max(
+        final int defaultCapacity = Math.max(
                 2 * Runtime.getRuntime().availableProcessors() + 1,
                 8);
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactory.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactory.java
index 195ef4b..16b945c 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactory.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/RecyclerFactory.java
@@ -22,7 +22,7 @@ import java.util.function.Supplier;
 @FunctionalInterface
 public interface RecyclerFactory {
 
-    default <V> Recycler<V> create(Supplier<V> supplier) {
+    default <V> Recycler<V> create(final Supplier<V> supplier) {
         return create(supplier, ignored -> {});
     }
 
diff --git a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/StringParameterParser.java b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/StringParameterParser.java
index 2600c14..c2333a5 100644
--- a/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/StringParameterParser.java
+++ b/log4j-layout-template-json/src/main/java/org/apache/logging/log4j/layout/template/json/util/StringParameterParser.java
@@ -67,7 +67,7 @@ public final class StringParameterParser {
 
         private final String string;
 
-        private StringValue(String string) {
+        private StringValue(final String string) {
             this.string = string;
         }
 
@@ -76,14 +76,14 @@ public final class StringParameterParser {
         }
 
         @Override
-        public boolean equals(Object object) {
+        public boolean equals(final Object object) {
             if (this == object) {
                 return true;
             }
             if (object == null || getClass() != object.getClass()) {
                 return false;
             }
-            StringValue that = (StringValue) object;
+            final StringValue that = (StringValue) object;
             return string.equals(that.string);
         }
 
@@ -103,7 +103,7 @@ public final class StringParameterParser {
 
         private final String doubleQuotedString;
 
-        private DoubleQuotedStringValue(String doubleQuotedString) {
+        private DoubleQuotedStringValue(final String doubleQuotedString) {
             this.doubleQuotedString = doubleQuotedString;
         }
 
@@ -112,14 +112,14 @@ public final class StringParameterParser {
         }
 
         @Override
-        public boolean equals(Object object) {
+        public boolean equals(final Object object) {
             if (this == object) {
                 return true;
             }
             if (object == null || getClass() != object.getClass()) {
                 return false;
             }
-            DoubleQuotedStringValue that = (DoubleQuotedStringValue) object;
+            final DoubleQuotedStringValue that = (DoubleQuotedStringValue) object;
             return doubleQuotedString.equals(that.doubleQuotedString);
         }