You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2012/07/29 02:52:34 UTC

svn commit: r1366778 - in /logging/log4j/log4j2/trunk: api/src/main/java/org/apache/logging/log4j/ api/src/main/java/org/apache/logging/log4j/message/ api/src/main/java/org/apache/logging/log4j/spi/ core/src/main/java/org/apache/logging/log4j/core/patt...

Author: rgoers
Date: Sun Jul 29 00:52:34 2012
New Revision: 1366778

URL: http://svn.apache.org/viewvc?rev=1366778&view=rev
Log:
Fix checkstyle errors

Modified:
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/MapMessage.java
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java
    logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/pattern/MessagePatternConverter.java
    logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Category.java
    logging/log4j/log4j2/trunk/slf4j-impl/src/main/java/org/slf4j/helpers/Log4JMDCAdapter.java

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java (original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java Sun Jul 29 00:52:34 2012
@@ -49,6 +49,7 @@ public interface Logger {
   /**
    * Log exiting from a method with the result. This may be coded as <br />
    *     return logger.exit(myResult);
+   * @param <R> The type of the parameter and object being returned.
    * @param result The result being returned from the method call.
    * @return the result.
    */
@@ -58,6 +59,7 @@ public interface Logger {
    * Log an exception or error to be thrown. This may be coded as <br />
    *    throw logger.throwing(myException);
    *
+   * @param <T> the Throwable type.
    * @param t The Throwable.
    * @return the Throwable.
    */
@@ -66,6 +68,7 @@ public interface Logger {
   /**
    * Log an exception or error to be thrown. This may be coded as <br />
    *    throw logger.throwing(debug, myException);
+   * @param <T> the Throwable type.
    * @param level The logging Level.
    * @param t The Throwable.
    * @return the Throwable.

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/MapMessage.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/MapMessage.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/MapMessage.java (original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/MapMessage.java Sun Jul 29 00:52:34 2012
@@ -32,7 +32,12 @@ public class MapMessage implements Multi
      */
 
     public enum MapFormat {
-        XML, JSON, JAVA
+        /** The map should be formatted as XML. */
+        XML,
+        /** The map should be formatted as JSON. */
+        JSON,
+        /** The map should be formatted the same as documented by java.util.AbstractMap.toString(). */
+        JAVA
     }
 
     private static final long serialVersionUID = -5031471831131487120L;

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java (original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java Sun Jul 29 00:52:34 2012
@@ -250,7 +250,7 @@ public class StructuredDataMessage exten
      * prepended and the event message to be appended. Specifying any other value will cause only the
      * StructuredData to be included. The default is "FULL".
      *
-     * @return
+     * @return the formatted message.
      */
     @Override
     public String getFormattedMessage(String[] formats) {

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java (original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java Sun Jul 29 00:52:34 2012
@@ -91,6 +91,7 @@ public abstract class AbstractLogger imp
     /**
      * Log exiting from a method with the result.
      *
+     * @param <R> The type of the parameter and object being returned.
      * @param result The result being returned from the method call.
      * @return the Throwable.
      */
@@ -104,6 +105,7 @@ public abstract class AbstractLogger imp
     /**
      * Log an exception or error to be thrown.
      *
+     * @param <T> the type of the Throwable.
      * @param t The Throwable.
      * @return the Throwable.
      */
@@ -118,6 +120,7 @@ public abstract class AbstractLogger imp
     /**
      * Log an exception or error to be thrown.
      *
+     * @param <T> the type of the Throwable.
      * @param level The logging Level.
      * @param t     The Throwable.
      * @return the Throwable.

Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/pattern/MessagePatternConverter.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/pattern/MessagePatternConverter.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/pattern/MessagePatternConverter.java (original)
+++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/pattern/MessagePatternConverter.java Sun Jul 29 00:52:34 2012
@@ -57,7 +57,7 @@ public final class MessagePatternConvert
         if (msg != null) {
             if (msg instanceof MultiformatMessage) {
                 toAppendTo.append(((MultiformatMessage) msg).getFormattedMessage(formats));
-            } else{
+            } else {
                 toAppendTo.append(msg.getFormattedMessage());
             }
         }

Modified: logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Category.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Category.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Category.java (original)
+++ logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Category.java Sun Jul 29 00:52:34 2012
@@ -303,7 +303,7 @@ public class Category {
 
     private void maybeLog(String fqcn, org.apache.logging.log4j.Level level,
             Object message, Throwable throwable) {
-        if(logger.isEnabled(level, null, message, throwable)) {
+        if (logger.isEnabled(level, null, message, throwable)) {
             logger.log(null, FQCN, level, new ObjectMessage(message), throwable);
         }
     }

Modified: logging/log4j/log4j2/trunk/slf4j-impl/src/main/java/org/slf4j/helpers/Log4JMDCAdapter.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/slf4j-impl/src/main/java/org/slf4j/helpers/Log4JMDCAdapter.java?rev=1366778&r1=1366777&r2=1366778&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/slf4j-impl/src/main/java/org/slf4j/helpers/Log4JMDCAdapter.java (original)
+++ logging/log4j/log4j2/trunk/slf4j-impl/src/main/java/org/slf4j/helpers/Log4JMDCAdapter.java Sun Jul 29 00:52:34 2012
@@ -19,7 +19,6 @@ package org.slf4j.helpers;
 import org.apache.logging.log4j.ThreadContext;
 import org.slf4j.spi.MDCAdapter;
 
-import java.util.HashMap;
 import java.util.Map;
 
 /**