You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2018/12/06 21:39:15 UTC

[logging-log4j2] 01/02: Use final.

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

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

commit deb871442858ee002d48e9bbf1615c14636466dc
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Dec 6 14:36:26 2018 -0700

    Use final.
---
 .../core/appender/db/AbstractDatabaseManager.java      |  2 +-
 .../core/appender/db/DbAppenderLoggingException.java   |  2 +-
 .../core/appender/rolling/RollingFileManager.java      | 10 +++++-----
 .../logging/log4j/core/pattern/HighlightConverter.java |  2 +-
 .../log4j/core/util/datetime/FixedDateFormat.java      | 10 +++++-----
 .../rolling/RollingAppenderDirectWrite1906Test.java    | 18 +++++++++---------
 .../rolling/RollingAppenderDirectWriteTest.java        | 10 +++++-----
 .../log4j/core/pattern/DatePatternConverterTest.java   | 10 +++++-----
 .../log4j/core/pattern/HighlightConverterTest.java     |  2 +-
 .../log4j/core/util/datetime/FixedDateFormatTest.java  | 12 ++++++------
 .../db/jdbc/PoolableConnectionFactoryTest.java         |  2 +-
 .../db/jdbc/PoolingDriverConnectionSourceTest.java     |  2 +-
 12 files changed, 41 insertions(+), 41 deletions(-)

diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.java
index de13542..b34cf8c 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.java
@@ -273,7 +273,7 @@ public abstract class AbstractDatabaseManager extends AbstractManager implements
      * @deprecated Use {@link #writeInternal(LogEvent, Serializable)}.
      */
     @Deprecated
-    protected void writeInternal(LogEvent event) {
+    protected void writeInternal(final LogEvent event) {
         writeInternal(event, null);
     }
 
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/DbAppenderLoggingException.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/DbAppenderLoggingException.java
index 389d26c..743f7ba 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/DbAppenderLoggingException.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/DbAppenderLoggingException.java
@@ -26,7 +26,7 @@ public class DbAppenderLoggingException extends AppenderLoggingException {
 
     private static final long serialVersionUID = 1L;
 
-    public DbAppenderLoggingException(String message, Throwable cause) {
+    public DbAppenderLoggingException(final String message, final Throwable cause) {
         super(message, cause);
     }
 
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/RollingFileManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/RollingFileManager.java
index 53b9b1d..8a9e980 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/RollingFileManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/RollingFileManager.java
@@ -662,17 +662,17 @@ public class RollingFileManager extends FileManager {
         }
     }
 
-    private static long initialFileTime(File file) {
-        Path path = file.toPath();
+    private static long initialFileTime(final File file) {
+        final Path path = file.toPath();
         if (Files.exists(path)) {
             try {
-                BasicFileAttributes attrs = Files.readAttributes(path, BasicFileAttributes.class);
-                FileTime fileTime = attrs.creationTime();
+                final BasicFileAttributes attrs = Files.readAttributes(path, BasicFileAttributes.class);
+                final FileTime fileTime = attrs.creationTime();
                 if (fileTime.compareTo(EPOCH) > 0) {
                     return fileTime.toMillis();
                 }
                 LOGGER.info("Unable to obtain file creation time for " + file.getAbsolutePath());
-            } catch (Exception ex) {
+            } catch (final Exception ex) {
                 LOGGER.info("Unable to calculate file creation time for " + file.getAbsolutePath() + ": " + ex.getMessage());
             }
         }
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 ce08319..a9b05a8 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
@@ -231,7 +231,7 @@ public final class HighlightConverter extends LogEventPatternConverter implement
     public void format(final LogEvent event, final StringBuilder toAppendTo) {
         int start = 0;
         int end = 0;
-        String levelStyle = levelStyles.get(event.getLevel().name());
+        final String levelStyle = levelStyles.get(event.getLevel().name());
         if (!noAnsi) { // use ANSI: set prefix
             start = toAppendTo.length();
             if (levelStyle != null) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormat.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormat.java
index dd80585..0d96baf 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormat.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormat.java
@@ -198,7 +198,7 @@ public class FixedDateFormat {
         }
 
         static FixedFormat lookupIgnoringNanos(final String pattern) {
-            int[] nanoRange = nanoRange(pattern);
+            final int[] nanoRange = nanoRange(pattern);
             final int nanoStart = nanoRange[0];
             final int nanoEnd = nanoRange[1];
             if (nanoStart > 0) {
@@ -320,7 +320,7 @@ public class FixedDateFormat {
             this(NONE, true, 4);
         }
 
-        private FixedTimeZoneFormat(char timeSeparatorChar, boolean minutes, int length) {
+        private FixedTimeZoneFormat(final char timeSeparatorChar, final boolean minutes, final int length) {
             this.timeSeparatorChar = timeSeparatorChar;
             this.timeSeparatorCharLen = timeSeparatorChar != NONE ? 1 : 0;
             this.useMinutes = minutes;
@@ -339,7 +339,7 @@ public class FixedDateFormat {
 
         // Profiling showed this method is important to log4j performance. Modify with care!
         // 262 bytes (will be inlined when hot enough: <= -XX:FreqInlineSize=325 bytes on Linux)
-        private int write(int offset, final char[] buffer, int pos) {
+        private int write(final int offset, final char[] buffer, int pos) {
             // This method duplicates part of writeTime()
 
             buffer[pos++] = offset < 0 ? '-' : '+';
@@ -574,7 +574,7 @@ public class FixedDateFormat {
         final long epochMillisecond = instant.getEpochMillisecond();
         int result = format(epochMillisecond, buffer, startPos);
         result -= digitsLessThanThree();
-        int pos = formatNanoOfMillisecond(instant.getNanoOfMillisecond(), buffer, startPos + result);
+        final int pos = formatNanoOfMillisecond(instant.getNanoOfMillisecond(), buffer, startPos + result);
         return writeTimeZone(epochMillisecond, buffer, pos);
     }
 
@@ -600,7 +600,7 @@ public class FixedDateFormat {
         // int ms = (int) (time % 86400000);
         final int ms = (int) (millisSinceMidnight(epochMillis));
         writeDate(buffer, startPos);
-        int pos = writeTime(ms, buffer, startPos + dateLength);
+        final int pos = writeTime(ms, buffer, startPos + dateLength);
         return pos - startPos;
     }
 
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWrite1906Test.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWrite1906Test.java
index 61fcf40..c58c0ad 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWrite1906Test.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWrite1906Test.java
@@ -62,7 +62,7 @@ public class RollingAppenderDirectWrite1906Test {
 
     @Test
     public void testAppender() throws Exception {
-        int count = 100;
+        final int count = 100;
         for (int i=0; i < count; ++i) {
             logger.debug("This is test message number " + i);
             Thread.sleep(50);
@@ -74,14 +74,14 @@ public class RollingAppenderDirectWrite1906Test {
         assertNotNull(files);
         assertThat(files, hasItemInArray(that(hasName(that(endsWith(".log"))))));
         int found = 0;
-        for (File file: files) {
-            String actual = file.getName();
-            BufferedReader reader = new BufferedReader(new FileReader(file));
+        for (final File file: files) {
+            final String actual = file.getName();
+            final BufferedReader reader = new BufferedReader(new FileReader(file));
             String line;
             while ((line = reader.readLine()) != null) {
                 assertNotNull("No log event in file " + actual, line);
-                String[] parts = line.split((" "));
-                String expected = "rollingfile." + parts[0] + ".log";
+                final String[] parts = line.split((" "));
+                final String expected = "rollingfile." + parts[0] + ".log";
 
                 assertEquals(logFileNameError(expected, actual), expected, actual);
                 ++found;
@@ -92,9 +92,9 @@ public class RollingAppenderDirectWrite1906Test {
 
     }
 
-    private String logFileNameError(String expected, String actual) {
-        List<StatusData> statusData = StatusLogger.getLogger().getStatusData();
-        for (StatusData statusItem : statusData) {
+    private String logFileNameError(final String expected, final String actual) {
+        final List<StatusData> statusData = StatusLogger.getLogger().getStatusData();
+        for (final StatusData statusItem : statusData) {
             System.err.println(statusItem.getFormattedStatus());
         }
         return "Incorrect file name. Expected: " + expected + " Actual: " + actual;
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWriteTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWriteTest.java
index 379f083..fcacb12 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWriteTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderDirectWriteTest.java
@@ -58,7 +58,7 @@ public class RollingAppenderDirectWriteTest {
 
     @Test
     public void testAppender() throws Exception {
-        int count = 100;
+        final int count = 100;
         for (int i=0; i < count; ++i) {
             logger.debug("This is test message number " + i);
         }
@@ -69,8 +69,8 @@ public class RollingAppenderDirectWriteTest {
         assertNotNull(files);
         assertThat(files, hasItemInArray(that(hasName(that(endsWith(".gz"))))));
         int found = 0;
-        for (File file: files) {
-            String actual = file.getName();
+        for (final File file: files) {
+            final String actual = file.getName();
             BufferedReader reader;
             if (file.getName().endsWith(".gz")) {
                 reader = new BufferedReader(new InputStreamReader(new GZIPInputStream(new FileInputStream(file))));
@@ -80,8 +80,8 @@ public class RollingAppenderDirectWriteTest {
             String line;
             while ((line = reader.readLine()) != null) {
                 assertNotNull("No log event in file " + actual, line);
-                String[] parts = line.split((" "));
-                String expected = "test1-" + parts[0];
+                final String[] parts = line.split((" "));
+                final String expected = "test1-" + parts[0];
                 assertTrue("Incorrect file name. Expected file prefix: " + expected + " Actual: " + actual,
                     actual.startsWith(expected));
                 ++found;
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/DatePatternConverterTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/DatePatternConverterTest.java
index 34f0b08..2857f81 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/DatePatternConverterTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/DatePatternConverterTest.java
@@ -111,8 +111,8 @@ public class DatePatternConverterTest {
     }
 
     private String precisePattern(final String pattern, final int precision) {
-        String search = "SSS";
-        int foundIndex = pattern.indexOf(search);
+        final String search = "SSS";
+        final int foundIndex = pattern.indexOf(search);
         final String seconds = pattern.substring(0, foundIndex);
         final String remainder = pattern.substring(foundIndex + search.length());
         return seconds + "nnnnnnnnn".substring(0, precision) + remainder;
@@ -347,7 +347,7 @@ public class DatePatternConverterTest {
         final LogEvent event = new MyLogEvent();
 
         for (final FixedDateFormat.FixedFormat format : FixedDateFormat.FixedFormat.values()) {
-            String pattern = format.getPattern();
+            final String pattern = format.getPattern();
             final String search = "SSS";
             final int foundIndex = pattern.indexOf(search);
             if (pattern.endsWith("n") || pattern.matches(".+n+X*") || pattern.matches(".+n+Z*")) {
@@ -373,7 +373,7 @@ public class DatePatternConverterTest {
 
             final String[] milliOptions = { pattern };
             DatePatternConverter.newInstance(milliOptions).format(event, milliBuilder);
-            FixedTimeZoneFormat timeZoneFormat = format.getFixedTimeZoneFormat();
+            final FixedTimeZoneFormat timeZoneFormat = format.getFixedTimeZoneFormat();
             final int truncateLen = 3 + (timeZoneFormat != null ? timeZoneFormat.getLength() : 0);
             final String tz = timeZoneFormat != null
                     ? milliBuilder.substring(milliBuilder.length() - timeZoneFormat.getLength(), milliBuilder.length())
@@ -422,7 +422,7 @@ public class DatePatternConverterTest {
 
                     final String[] milliOptions = { pattern, timeZone };
                     DatePatternConverter.newInstance(milliOptions).format(event, milliBuilder);
-                    FixedTimeZoneFormat timeZoneFormat = format.getFixedTimeZoneFormat();
+                    final FixedTimeZoneFormat timeZoneFormat = format.getFixedTimeZoneFormat();
                     final int truncateLen = 3 + (timeZoneFormat != null ? timeZoneFormat.getLength() : 0);
                     final String tz = timeZoneFormat != null
                             ? milliBuilder.substring(milliBuilder.length() - timeZoneFormat.getLength(),
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/HighlightConverterTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/HighlightConverterTest.java
index 589367b..40215a2 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/HighlightConverterTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/pattern/HighlightConverterTest.java
@@ -78,7 +78,7 @@ public class HighlightConverterTest {
 
     @Test
     public void testLevelNamesUnknown() {
-        String colorName = "blue";
+        final String colorName = "blue";
         final String[] options = { "%level", PatternParser.NO_CONSOLE_NO_ANSI + "=false, " + PatternParser.DISABLE_ANSI
                 + "=false, " + "DEBUG=" + colorName + ", CUSTOM1=" + colorName };
         final HighlightConverter converter = HighlightConverter.newInstance(null, options);
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormatTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormatTest.java
index 123484b..3caab80 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormatTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/util/datetime/FixedDateFormatTest.java
@@ -159,7 +159,7 @@ public class FixedDateFormatTest {
         final long start = now - TimeUnit.HOURS.toMillis(25);
         final long end = now + TimeUnit.HOURS.toMillis(25);
         for (final FixedFormat format : FixedFormat.values()) {
-            String pattern = format.getPattern();
+            final String pattern = format.getPattern();
             if (containsNanos(format) || format.getFixedTimeZoneFormat() != null) {
                 continue; // cannot compile precise timestamp formats with SimpleDateFormat
             }
@@ -179,7 +179,7 @@ public class FixedDateFormatTest {
         final long start = now - TimeUnit.HOURS.toMillis(25);
         final long end = now + TimeUnit.HOURS.toMillis(25);
         for (final FixedFormat format : FixedFormat.values()) {
-            String pattern = format.getPattern();
+            final String pattern = format.getPattern();
             if (containsNanos(format) || format.getFixedTimeZoneFormat() != null) {
                 continue; // cannot compile precise timestamp formats with SimpleDateFormat
             }
@@ -200,7 +200,7 @@ public class FixedDateFormatTest {
         final long end = now + TimeUnit.HOURS.toMillis(25);
         final char[] buffer = new char[128];
         for (final FixedFormat format : FixedFormat.values()) {
-            String pattern = format.getPattern();
+            final String pattern = format.getPattern();
             if (containsNanos(format) || format.getFixedTimeZoneFormat() != null) {
                 // cannot compile precise timestamp formats with SimpleDateFormat
                 // This format() API not include the TZ
@@ -224,7 +224,7 @@ public class FixedDateFormatTest {
         final long end = now + TimeUnit.HOURS.toMillis(25);
         final char[] buffer = new char[128];
         for (final FixedFormat format : FixedFormat.values()) {
-            String pattern = format.getPattern();
+            final String pattern = format.getPattern();
             if (pattern.endsWith("n") || pattern.matches(".+n+X*") || pattern.matches(".+n+Z*") || format.getFixedTimeZoneFormat() != null) {
                 continue; // cannot compile precise timestamp formats with SimpleDateFormat
             }
@@ -370,7 +370,7 @@ public class FixedDateFormatTest {
         }
     }
     
-    private boolean containsNanos(FixedFormat fixedFormat) {
+    private boolean containsNanos(final FixedFormat fixedFormat) {
         final String pattern = fixedFormat.getPattern();
         return pattern.endsWith("n") || pattern.matches(".+n+X*") || pattern.matches(".+n+Z*");
     }
@@ -389,7 +389,7 @@ public class FixedDateFormatTest {
         final long end = now + TimeUnit.HOURS.toMillis(1);
 
         for (final FixedFormat format : FixedFormat.values()) {
-            String pattern = format.getPattern();
+            final String pattern = format.getPattern();
             if (containsNanos(format) || format.getFixedTimeZoneFormat() != null) {
                 continue; // cannot compile precise timestamp formats with SimpleDateFormat
             }
diff --git a/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolableConnectionFactoryTest.java b/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolableConnectionFactoryTest.java
index cf1dc99..54a3973 100644
--- a/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolableConnectionFactoryTest.java
+++ b/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolableConnectionFactoryTest.java
@@ -32,7 +32,7 @@ public class PoolableConnectionFactoryTest {
 
     @Test
     public void test() {
-        Appender appender = LCR.getAppender("databaseAppender");
+        final Appender appender = LCR.getAppender("databaseAppender");
         Assert.assertNotNull("Problem loading configuration from " + REL_PATH, appender);
     }
 }
diff --git a/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolingDriverConnectionSourceTest.java b/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolingDriverConnectionSourceTest.java
index eba4d9c..fd699d9 100644
--- a/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolingDriverConnectionSourceTest.java
+++ b/log4j-jdbc-dbcp2/src/test/java/org/apache/logging/log4j/core/appender/db/jdbc/PoolingDriverConnectionSourceTest.java
@@ -96,7 +96,7 @@ public class PoolingDriverConnectionSourceTest {
 
     @Test
     public void testPoolableConnectionFactoryConfig() throws SQLException {
-        PoolableConnectionFactoryConfig poolableConnectionFactoryConfig = PoolableConnectionFactoryConfig.newBuilder().setMaxConnLifetimeMillis(30000).build();
+        final PoolableConnectionFactoryConfig poolableConnectionFactoryConfig = PoolableConnectionFactoryConfig.newBuilder().setMaxConnLifetimeMillis(30000).build();
         // @formatter:off
         final PoolingDriverConnectionSource source = PoolingDriverConnectionSource.newPoolingDriverConnectionSourceBuilder()
             .setConnectionString(JdbcH2TestHelper.CONNECTION_STRING_MEM)