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 2020/11/17 13:57:13 UTC
[logging-log4j2] 02/02: Address some generics compiler warnings and
formatting nits. Close HTML tags in Javadocs. Normalize some formatting and
Javadocs.
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 06d90549d4da2d2132313b1abe584de52f5c7df4
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Nov 17 08:57:04 2020 -0500
Address some generics compiler warnings and formatting nits. Close HTML
tags in Javadocs. Normalize some formatting and Javadocs.
---
.../java/org/apache/log4j/AppenderSkeleton.java | 2 +-
.../src/main/java/org/apache/log4j/Category.java | 43 +++++++++++----------
.../java/org/apache/log4j/ConsoleAppender.java | 44 ++++++++++------------
.../src/main/java/org/apache/log4j/MDC.java | 1 -
.../main/java/org/apache/log4j/SimpleLayout.java | 33 ++++++++--------
.../main/java/org/apache/log4j/WriterAppender.java | 3 +-
.../org/apache/log4j/bridge/LayoutWrapper.java | 2 -
.../org/apache/log4j/bridge/LogEventWrapper.java | 1 -
.../org/apache/log4j/builders/BooleanHolder.java | 1 +
.../org/apache/log4j/rewrite/MapRewritePolicy.java | 1 +
.../log4j/rewrite/PropertyRewritePolicy.java | 20 ++++++----
.../org/apache/log4j/spi/ThrowableInformation.java | 9 ++---
.../org/apache/log4j/xml/Log4jEntityResolver.java | 2 +-
13 files changed, 78 insertions(+), 84 deletions(-)
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/AppenderSkeleton.java b/log4j-1.2-api/src/main/java/org/apache/log4j/AppenderSkeleton.java
index 1353dae..e2d6a18 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/AppenderSkeleton.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/AppenderSkeleton.java
@@ -118,7 +118,7 @@ public abstract class AppenderSkeleton implements Appender, OptionHandler {
}
/**
- * Set the {@link ErrorHandler} for this Appender.
+ * Sets the {@link ErrorHandler} for this Appender.
*
* @since 0.9.0
*/
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/Category.java b/log4j-1.2-api/src/main/java/org/apache/log4j/Category.java
index 0454377..516e1f8 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/Category.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/Category.java
@@ -176,14 +176,17 @@ public class Category {
}
/**
- Returns all the currently defined categories in the default
- hierarchy as an {@link java.util.Enumeration Enumeration}.
-
- <p>The root category is <em>not</em> included in the returned
- {@link Enumeration}.
- @return and Enumeration of the Categories.
-
- @deprecated Please use {@link LogManager#getCurrentLoggers()} instead.
+ * Returns all the currently defined categories in the default hierarchy as an
+ * {@link java.util.Enumeration Enumeration}.
+ *
+ * <p>
+ * The root category is <em>not</em> included in the returned
+ * {@link Enumeration}.
+ * </p>
+ *
+ * @return and Enumeration of the Categories.
+ *
+ * @deprecated Please use {@link LogManager#getCurrentLoggers()} instead.
*/
@SuppressWarnings("rawtypes")
@Deprecated
@@ -444,18 +447,18 @@ public class Category {
}
/**
- If <code>assertion</code> parameter is {@code false}, then
- logs <code>msg</code> as an {@link #error(Object) error} statement.
-
- <p>The <code>assert</code> method has been renamed to
- <code>assertLog</code> because <code>assert</code> is a language
- reserved word in JDK 1.4.
-
- @param assertion The assertion.
- @param msg The message to print if <code>assertion</code> is
- false.
-
- @since 1.2
+ * If <code>assertion</code> parameter is {@code false}, then logs
+ * <code>msg</code> as an {@link #error(Object) error} statement.
+ *
+ * <p>
+ * The <code>assert</code> method has been renamed to <code>assertLog</code>
+ * because <code>assert</code> is a language reserved word in JDK 1.4.
+ * </p>
+ *
+ * @param assertion The assertion.
+ * @param msg The message to print if <code>assertion</code> is false.
+ *
+ * @since 1.2
*/
public void assertLog(final boolean assertion, final String msg) {
if (!assertion) {
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/ConsoleAppender.java b/log4j-1.2-api/src/main/java/org/apache/log4j/ConsoleAppender.java
index 605fac7..9aa2cf1 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/ConsoleAppender.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/ConsoleAppender.java
@@ -21,32 +21,28 @@ import org.apache.log4j.spi.LoggingEvent;
/**
* Console-appender.
*/
-public class ConsoleAppender extends AppenderSkeleton
-{
+public class ConsoleAppender extends AppenderSkeleton {
- /**
- * {@inheritDoc}
- */
- @Override
- public void close()
- {
- }
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void close() {
+ }
- /**
- * {@inheritDoc}
- */
- @Override
- public boolean requiresLayout()
- {
- return false;
- }
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean requiresLayout() {
+ return false;
+ }
- /**
- * {@inheritDoc}
- */
- @Override
- protected void append(final LoggingEvent theEvent)
- {
- }
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected void append(final LoggingEvent theEvent) {
+ }
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/MDC.java b/log4j-1.2-api/src/main/java/org/apache/log4j/MDC.java
index 1012d29..48ef698 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/MDC.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/MDC.java
@@ -28,7 +28,6 @@ import org.apache.logging.log4j.ThreadContext;
*/
public final class MDC {
-
private static ThreadLocal<Map<String, Object>> localMap =
new InheritableThreadLocal<Map<String, Object>>() {
@Override
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/SimpleLayout.java b/log4j-1.2-api/src/main/java/org/apache/log4j/SimpleLayout.java
index c77b9be..2ed850d 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/SimpleLayout.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/SimpleLayout.java
@@ -22,25 +22,22 @@ import org.apache.logging.log4j.util.Strings;
/**
* Simple-layout.
*/
-public class SimpleLayout extends Layout
-{
+public class SimpleLayout extends Layout {
- /**
- * {@inheritDoc}
- */
- @Override
- public String format(final LoggingEvent theEvent)
- {
- return Strings.EMPTY;
- }
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public String format(final LoggingEvent theEvent) {
+ return Strings.EMPTY;
+ }
- /**
- * {@inheritDoc}
- */
- @Override
- public boolean ignoresThrowable()
- {
- return true;
- }
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean ignoresThrowable() {
+ return true;
+ }
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java b/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java
index cd7b649..8f31285 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java
@@ -195,8 +195,7 @@ public class WriterAppender extends AppenderSkeleton {
* @since 0.8.4
*/
@Override
- public
- synchronized void close() {
+ public synchronized void close() {
if (this.closed) {
return;
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LayoutWrapper.java b/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LayoutWrapper.java
index fc1e72f..d2ebaff 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LayoutWrapper.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LayoutWrapper.java
@@ -16,11 +16,9 @@
*/
package org.apache.log4j.bridge;
-
import org.apache.log4j.Layout;
import org.apache.log4j.spi.LoggingEvent;
-
/**
* Bridge between the Log4j 1 Layout and a Log4j 2 Layout.
*/
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LogEventWrapper.java b/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LogEventWrapper.java
index 2591bc5..2a8f7d4 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LogEventWrapper.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/LogEventWrapper.java
@@ -186,7 +186,6 @@ public class LogEventWrapper implements LogEvent {
return 0;
}
-
private static class ContextDataMap extends HashMap<String, String> implements ReadOnlyStringMap {
ContextDataMap(Map<String, String> map) {
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/builders/BooleanHolder.java b/log4j-1.2-api/src/main/java/org/apache/log4j/builders/BooleanHolder.java
index 16e46d3..42ad615 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/builders/BooleanHolder.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/builders/BooleanHolder.java
@@ -20,6 +20,7 @@ package org.apache.log4j.builders;
* Holds Boolean values created inside of a Lambda expression.
*/
public class BooleanHolder extends Holder<Boolean> {
+
public BooleanHolder() {
super(Boolean.FALSE);
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/MapRewritePolicy.java b/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/MapRewritePolicy.java
index 763990d..e157f3c 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/MapRewritePolicy.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/MapRewritePolicy.java
@@ -44,6 +44,7 @@ import java.util.Map;
* <p>
* The combination of the RewriteAppender and this policy
* performs the same actions as the MapFilter from log4j 1.3.
+ * </p>
*/
public class MapRewritePolicy implements RewritePolicy {
/**
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/PropertyRewritePolicy.java b/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/PropertyRewritePolicy.java
index 4d6dc2e..16e765c 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/PropertyRewritePolicy.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/rewrite/PropertyRewritePolicy.java
@@ -37,8 +37,8 @@ import java.util.StringTokenizer;
* <p>
* The combination of the RewriteAppender and this policy
* performs the same actions as the PropertyFilter from log4j 1.3.
+ * </p>
*/
-
public class PropertyRewritePolicy implements RewritePolicy {
private Map<String, String> properties = Collections.EMPTY_MAP;
@@ -48,19 +48,23 @@ public class PropertyRewritePolicy implements RewritePolicy {
/**
* Set a string representing the property name/value pairs.
* <p>
- * Form: propname1=propvalue1,propname2=propvalue2
+ * Form:
+ * </p>
+ * <pre>
+ * propname1=propvalue1,propname2=propvalue2
+ * </pre>
*
- * @param props The properties.
+ * @param properties The properties.
*/
- public void setProperties(String props) {
- Map hashTable = new HashMap();
- StringTokenizer pairs = new StringTokenizer(props, ",");
+ public void setProperties(String properties) {
+ Map<String, String> newMap = new HashMap<>();
+ StringTokenizer pairs = new StringTokenizer(properties, ",");
while (pairs.hasMoreTokens()) {
StringTokenizer entry = new StringTokenizer(pairs.nextToken(), "=");
- hashTable.put(entry.nextElement().toString().trim(), entry.nextElement().toString().trim());
+ newMap.put(entry.nextElement().toString().trim(), entry.nextElement().toString().trim());
}
synchronized (this) {
- properties = hashTable;
+ this.properties = newMap;
}
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ThrowableInformation.java b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ThrowableInformation.java
index 6b83c7c..0e82a1c 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ThrowableInformation.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/ThrowableInformation.java
@@ -30,13 +30,11 @@ public class ThrowableInformation implements java.io.Serializable {
private transient Throwable throwable;
private Method toStringList;
- @SuppressWarnings("unchecked")
- public
- ThrowableInformation(Throwable throwable) {
+ public ThrowableInformation(Throwable throwable) {
this.throwable = throwable;
Method method = null;
try {
- Class throwables = Class.forName("org.apache.logging.log4j.core.util.Throwables");
+ Class<?> throwables = Class.forName("org.apache.logging.log4j.core.util.Throwables");
method = throwables.getMethod("toStringList", Throwable.class);
} catch (ClassNotFoundException | NoSuchMethodException ex) {
// Ignore the exception if Log4j-core is not present.
@@ -44,8 +42,7 @@ public class ThrowableInformation implements java.io.Serializable {
this.toStringList = method;
}
- public
- Throwable getThrowable() {
+ public Throwable getThrowable() {
return throwable;
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/xml/Log4jEntityResolver.java b/log4j-1.2-api/src/main/java/org/apache/log4j/xml/Log4jEntityResolver.java
index 1417b7d..8bd0ff3 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/xml/Log4jEntityResolver.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/xml/Log4jEntityResolver.java
@@ -37,7 +37,7 @@ public class Log4jEntityResolver implements EntityResolver {
@Override
public InputSource resolveEntity(String publicId, String systemId) {
if (systemId.endsWith("log4j.dtd") || PUBLIC_ID.equals(publicId)) {
- Class clazz = getClass();
+ Class<?> clazz = getClass();
InputStream in = clazz.getResourceAsStream("/org/apache/log4j/xml/log4j.dtd");
if (in == null) {
LOGGER.warn("Could not find [log4j.dtd] using [{}] class loader, parsed without DTD.",