Return-Path: X-Original-To: apmail-logging-commits-archive@minotaur.apache.org Delivered-To: apmail-logging-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id EC3A2102B8 for ; Wed, 22 Jan 2014 17:05:58 +0000 (UTC) Received: (qmail 2523 invoked by uid 500); 22 Jan 2014 17:05:58 -0000 Delivered-To: apmail-logging-commits-archive@logging.apache.org Received: (qmail 2494 invoked by uid 500); 22 Jan 2014 17:05:57 -0000 Mailing-List: contact commits-help@logging.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@logging.apache.org Delivered-To: mailing list commits@logging.apache.org Received: (qmail 2487 invoked by uid 99); 22 Jan 2014 17:05:57 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 22 Jan 2014 17:05:57 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 22 Jan 2014 17:05:48 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id D08B323888A6; Wed, 22 Jan 2014 17:05:25 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1560417 - /logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java Date: Wed, 22 Jan 2014 17:05:25 -0000 To: commits@logging.apache.org From: ggregory@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20140122170525.D08B323888A6@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: ggregory Date: Wed Jan 22 17:05:25 2014 New Revision: 1560417 URL: http://svn.apache.org/r1560417 Log: Make Javadoc format consistent. Modified: logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java Modified: logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java?rev=1560417&r1=1560416&r2=1560417&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java (original) +++ logging/log4j/log4j2/trunk/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java Wed Jan 22 17:05:25 2014 @@ -50,7 +50,6 @@ public abstract class AbstractLogger imp */ public static final Marker EXIT_MARKER = MarkerManager.getMarker("EXIT", FLOW_MARKER); - /** * Marker for exception tracing. */ @@ -69,8 +68,7 @@ public abstract class AbstractLogger imp /** * The default MessageFactory class. */ - public static final Class DEFAULT_MESSAGE_FACTORY_CLASS = - ParameterizedMessageFactory.class; + public static final Class DEFAULT_MESSAGE_FACTORY_CLASS = ParameterizedMessageFactory.class; private static final String FQCN = AbstractLogger.class.getName(); @@ -82,28 +80,24 @@ public abstract class AbstractLogger imp * Checks that the message factory a logger was created with is the same as the given messageFactory. If they are * different log a warning to the {@linkplain StatusLogger}. A null MessageFactory translates to the default * MessageFactory {@link #DEFAULT_MESSAGE_FACTORY_CLASS}. - * - * @param logger - * The logger to check - * @param messageFactory - * The message factory to check. + * + * @param logger The logger to check + * @param messageFactory The message factory to check. */ public static void checkMessageFactory(final Logger logger, final MessageFactory messageFactory) { final String name = logger.getName(); final MessageFactory loggerMessageFactory = logger.getMessageFactory(); if (messageFactory != null && !loggerMessageFactory.equals(messageFactory)) { + StatusLogger.getLogger().warn( + "The Logger {} was created with the message factory {} and is now requested with the " + + "message factory {}, which may create log events with unexpected formatting.", name, + loggerMessageFactory, messageFactory); + } else if (messageFactory == null && !loggerMessageFactory.getClass().equals(DEFAULT_MESSAGE_FACTORY_CLASS)) { StatusLogger - .getLogger() - .warn("The Logger {} was created with the message factory {} and is now requested with the " + - "message factory {}, which may create log events with unexpected formatting.", - name, loggerMessageFactory, messageFactory); - } else if (messageFactory == null - && !loggerMessageFactory.getClass().equals(DEFAULT_MESSAGE_FACTORY_CLASS)) { - StatusLogger - .getLogger() - .warn("The Logger {} was created with the message factory {} and is now requested with a null " + - "message factory (defaults to {}), which may create log events with unexpected formatting.", - name, loggerMessageFactory, DEFAULT_MESSAGE_FACTORY_CLASS.getName()); + .getLogger() + .warn("The Logger {} was created with the message factory {} and is now requested with a null " + + "message factory (defaults to {}), which may create log events with unexpected formatting.", + name, loggerMessageFactory, DEFAULT_MESSAGE_FACTORY_CLASS.getName()); } } @@ -121,7 +115,7 @@ public abstract class AbstractLogger imp /** * Creates a new named logger. - * + * * @param name the logger name */ public AbstractLogger(final String name) { @@ -131,7 +125,7 @@ public abstract class AbstractLogger imp /** * Creates a new named logger. - * + * * @param name the logger name * @param messageFactory the message factory, if null then use the default message factory. */ @@ -142,9 +136,9 @@ public abstract class AbstractLogger imp /** * Logs a Throwable that has been caught. - * + * * @param level The logging Level. - * @param t The Throwable. + * @param t The Throwable. */ @Override public void catching(final Level level, final Throwable t) { @@ -153,7 +147,7 @@ public abstract class AbstractLogger imp /** * Logs a Throwable that has been caught with location information. - * + * * @param fqcn The fully qualified class name of the caller. * @param level The logging level. * @param t The Throwable. @@ -166,7 +160,7 @@ public abstract class AbstractLogger imp /** * Logs a Throwable at the {@link Level#ERROR ERROR} level.. - * + * * @param t The Throwable. */ @Override @@ -186,9 +180,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the DEBUG level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged + * @param msg the message string to be logged */ @Override public void debug(final Marker marker, final Message msg) { @@ -199,10 +193,10 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the DEBUG level. - * + * * @param marker the marker data specific to this log statement. - * @param msg the message string to be logged - * @param t A Throwable or null. + * @param msg the message string to be logged + * @param t A Throwable or null. */ @Override public void debug(final Marker marker, final Message msg, final Throwable t) { @@ -213,7 +207,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#DEBUG DEBUG} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -225,12 +219,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#DEBUG DEBUG} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#DEBUG DEBUG} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void debug(final Marker marker, final Object message, final Throwable t) { @@ -241,7 +235,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#DEBUG DEBUG} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -254,10 +248,10 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#DEBUG DEBUG} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void debug(final Marker marker, final String message, final Object... params) { @@ -268,12 +262,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#DEBUG DEBUG} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#DEBUG DEBUG} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void debug(final Marker marker, final String message, final Throwable t) { @@ -284,7 +278,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the DEBUG level. - * + * * @param msg the message string to be logged */ @Override @@ -296,9 +290,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the DEBUG level. - * + * * @param msg the message string to be logged - * @param t A Throwable or null. + * @param t A Throwable or null. */ @Override public void debug(final Message msg, final Throwable t) { @@ -309,7 +303,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#DEBUG DEBUG} level. - * + * * @param message the message object to log. */ @Override @@ -320,11 +314,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#DEBUG DEBUG} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#DEBUG DEBUG} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void debug(final Object message, final Throwable t) { @@ -335,7 +329,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#DEBUG DEBUG} level. - * + * * @param message the message object to log. */ @Override @@ -347,9 +341,9 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#DEBUG DEBUG} level. - * + * * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void debug(final String message, final Object... params) { @@ -360,11 +354,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#DEBUG DEBUG} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#DEBUG DEBUG} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void debug(final String message, final Throwable t) { @@ -383,7 +377,7 @@ public abstract class AbstractLogger imp /** * Logs entry to a method. - * + * * @param params The parameters to the method. */ @Override @@ -393,7 +387,7 @@ public abstract class AbstractLogger imp /** * Logs entry to a method with location information. - * + * * @param fqcn The fully qualified class name of the caller. * @param params The parameters to the method. */ @@ -423,12 +417,11 @@ public abstract class AbstractLogger imp return messageFactory.newMessage(sb.toString()); } - /** * Logs a message with the specific Marker at the {@link Level#ERROR ERROR} level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged + * @param msg the message string to be logged */ @Override public void error(final Marker marker, final Message msg) { @@ -439,10 +432,10 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the {@link Level#ERROR ERROR} level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged - * @param t A Throwable or null. + * @param msg the message string to be logged + * @param t A Throwable or null. */ @Override public void error(final Marker marker, final Message msg, final Throwable t) { @@ -453,7 +446,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#ERROR ERROR} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -465,12 +458,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#ERROR ERROR} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#ERROR ERROR} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void error(final Marker marker, final Object message, final Throwable t) { @@ -481,7 +474,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#ERROR ERROR} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -494,10 +487,10 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#ERROR ERROR} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void error(final Marker marker, final String message, final Object... params) { @@ -508,12 +501,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#ERROR ERROR} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#ERROR ERROR} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void error(final Marker marker, final String message, final Throwable t) { @@ -524,7 +517,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the {@link Level#ERROR ERROR} level. - * + * * @param msg the message string to be logged */ @Override @@ -536,9 +529,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the {@link Level#ERROR ERROR} level. - * + * * @param msg the message string to be logged - * @param t A Throwable or null. + * @param t A Throwable or null. */ @Override public void error(final Message msg, final Throwable t) { @@ -549,7 +542,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#ERROR ERROR} level. - * + * * @param message the message object to log. */ @Override @@ -560,11 +553,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#ERROR ERROR} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#ERROR ERROR} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void error(final Object message, final Throwable t) { @@ -575,7 +568,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#ERROR ERROR} level. - * + * * @param message the message object to log. */ @Override @@ -587,9 +580,9 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#ERROR ERROR} level. - * + * * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void error(final String message, final Object... params) { @@ -600,11 +593,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#ERROR ERROR} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#ERROR ERROR} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void error(final String message, final Throwable t) { @@ -623,7 +616,7 @@ public abstract class AbstractLogger imp /** * Logs exiting from a method with the result. - * + * * @param The type of the parameter and object being returned. * @param result The result being returned from the method call. * @return the Throwable. @@ -635,7 +628,7 @@ public abstract class AbstractLogger imp /** * Logs exiting from a method with the result and location information. - * + * * @param fqcn The fully qualified class name of the caller. * @param The type of the parameter and object being returned. * @param result The result being returned from the method call. @@ -649,9 +642,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the FATAL level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged + * @param msg the message string to be logged */ @Override public void fatal(final Marker marker, final Message msg) { @@ -662,10 +655,10 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the FATAL level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged - * @param t A Throwable or null. + * @param msg the message string to be logged + * @param t A Throwable or null. */ @Override public void fatal(final Marker marker, final Message msg, final Throwable t) { @@ -676,7 +669,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#FATAL FATAL} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -688,12 +681,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#FATAL FATAL} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#FATAL FATAL} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void fatal(final Marker marker, final Object message, final Throwable t) { @@ -704,7 +697,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#FATAL FATAL} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -717,10 +710,10 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#FATAL FATAL} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void fatal(final Marker marker, final String message, final Object... params) { @@ -731,12 +724,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#FATAL FATAL} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#FATAL FATAL} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void fatal(final Marker marker, final String message, final Throwable t) { @@ -744,9 +737,10 @@ public abstract class AbstractLogger imp log(marker, FQCN, Level.FATAL, messageFactory.newMessage(message), t); } } + /** * Logs a message with the specific Marker at the FATAL level. - * + * * @param msg the message string to be logged */ @Override @@ -758,9 +752,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the FATAL level. - * + * * @param msg the message string to be logged - * @param t A Throwable or null. + * @param t A Throwable or null. */ @Override public void fatal(final Message msg, final Throwable t) { @@ -771,7 +765,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#FATAL FATAL} level. - * + * * @param message the message object to log. */ @Override @@ -782,11 +776,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#FATAL FATAL} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#FATAL FATAL} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void fatal(final Object message, final Throwable t) { @@ -797,7 +791,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#FATAL FATAL} level. - * + * * @param message the message object to log. */ @Override @@ -809,9 +803,9 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#FATAL FATAL} level. - * + * * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void fatal(final String message, final Object... params) { @@ -822,11 +816,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#FATAL FATAL} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#FATAL FATAL} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void fatal(final String message, final Throwable t) { @@ -837,7 +831,7 @@ public abstract class AbstractLogger imp /** * Gets the message factory. - * + * * @return the message factory. */ @Override @@ -845,7 +839,9 @@ public abstract class AbstractLogger imp return messageFactory; } - /* (non-Javadoc) + /* + * (non-Javadoc) + * * @see org.apache.logging.log4j.Logger#getName() */ @Override @@ -855,7 +851,7 @@ public abstract class AbstractLogger imp /** * Gets a print stream that logs lines to this logger. - * + * * @param level the logging level * @return print stream that logs printed lines to this logger. */ @@ -866,9 +862,9 @@ public abstract class AbstractLogger imp /** * Gets a marked print stream that logs lines to this logger. - * + * * @param marker the marker data specific to this log statement - * @param level the logging level + * @param level the logging level * @return print stream that logs printed lines to this logger. */ @Override @@ -878,9 +874,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the INFO level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged + * @param msg the message string to be logged */ @Override public void info(final Marker marker, final Message msg) { @@ -891,10 +887,10 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the INFO level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged - * @param t A Throwable or null. + * @param msg the message string to be logged + * @param t A Throwable or null. */ @Override public void info(final Marker marker, final Message msg, final Throwable t) { @@ -905,7 +901,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#INFO INFO} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -917,12 +913,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#INFO INFO} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#INFO INFO} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void info(final Marker marker, final Object message, final Throwable t) { @@ -933,7 +929,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#INFO INFO} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -946,10 +942,10 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#INFO INFO} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void info(final Marker marker, final String message, final Object... params) { @@ -960,12 +956,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#INFO INFO} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#INFO INFO} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void info(final Marker marker, final String message, final Throwable t) { @@ -976,7 +972,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the TRACE level. - * + * * @param msg the message string to be logged */ @Override @@ -988,9 +984,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the INFO level. - * + * * @param msg the message string to be logged - * @param t A Throwable or null. + * @param t A Throwable or null. */ @Override public void info(final Message msg, final Throwable t) { @@ -1001,7 +997,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#INFO INFO} level. - * + * * @param message the message object to log. */ @Override @@ -1011,13 +1007,12 @@ public abstract class AbstractLogger imp } } - /** - * Logs a message at the {@link Level#INFO INFO} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#INFO INFO} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void info(final Object message, final Throwable t) { @@ -1028,7 +1023,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#INFO INFO} level. - * + * * @param message the message object to log. */ @Override @@ -1040,9 +1035,9 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#INFO INFO} level. - * + * * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void info(final String message, final Object... params) { @@ -1053,11 +1048,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#INFO INFO} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#INFO INFO} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void info(final String message, final Throwable t) { @@ -1068,9 +1063,8 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the DEBUG Level. - * - * @return boolean - {@code true} if this Logger is enabled for level - * DEBUG, {@code false} otherwise. + * + * @return boolean - {@code true} if this Logger is enabled for level DEBUG, {@code false} otherwise. */ @Override public boolean isDebugEnabled() { @@ -1079,10 +1073,9 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the DEBUG Level. - * + * * @param marker The marker data. - * @return boolean - {@code true} if this Logger is enabled for level - * DEBUG, {@code false} otherwise. + * @return boolean - {@code true} if this Logger is enabled for level DEBUG, {@code false} otherwise. */ @Override public boolean isDebugEnabled(final Marker marker) { @@ -1094,6 +1087,7 @@ public abstract class AbstractLogger imp *

* Note that passing in {@link Level#OFF OFF} always returns {@code true}. *

+ * * @param level the level to check * @return boolean - {@code true} if this Logger is enabled for level, {@code false} otherwise. */ @@ -1109,6 +1103,7 @@ public abstract class AbstractLogger imp /** * Determine if logging is enabled. + * * @param level The logging Level to check. * @param marker A Marker or null. * @param data The Message. @@ -1119,6 +1114,7 @@ public abstract class AbstractLogger imp /** * Determine if logging is enabled. + * * @param level The logging Level to check. * @param marker A Marker or null. * @param data The message. @@ -1129,6 +1125,7 @@ public abstract class AbstractLogger imp /** * Determine if logging is enabled. + * * @param level The logging Level to check. * @param marker A Marker or null. * @param data The message. @@ -1138,6 +1135,7 @@ public abstract class AbstractLogger imp /** * Determine if logging is enabled. + * * @param level The logging Level to check. * @param marker A Marker or null. * @param data The message. @@ -1148,6 +1146,7 @@ public abstract class AbstractLogger imp /** * Determine if logging is enabled. + * * @param level The logging Level to check. * @param marker A Marker or null. * @param data The message. @@ -1158,9 +1157,9 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level. - * - * @return boolean - {@code true} if this Logger is enabled for level - * {@link Level#ERROR ERROR}, {@code false} otherwise. + * + * @return boolean - {@code true} if this Logger is enabled for level {@link Level#ERROR ERROR}, {@code false} + * otherwise. */ @Override public boolean isErrorEnabled() { @@ -1169,10 +1168,10 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level. - * + * * @param marker The marker data. - * @return boolean - {@code true} if this Logger is enabled for level - * {@link Level#ERROR ERROR}, {@code false} otherwise. + * @return boolean - {@code true} if this Logger is enabled for level {@link Level#ERROR ERROR}, {@code false} + * otherwise. */ @Override public boolean isErrorEnabled(final Marker marker) { @@ -1181,9 +1180,8 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the FATAL Level. - * - * @return boolean - {@code true} if this Logger is enabled for level - * FATAL, {@code false} otherwise. + * + * @return boolean - {@code true} if this Logger is enabled for level FATAL, {@code false} otherwise. */ @Override public boolean isFatalEnabled() { @@ -1192,10 +1190,9 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the FATAL Level. - * + * * @param marker The marker data. - * @return boolean - {@code true} if this Logger is enabled for level - * FATAL, {@code false} otherwise. + * @return boolean - {@code true} if this Logger is enabled for level FATAL, {@code false} otherwise. */ @Override public boolean isFatalEnabled(final Marker marker) { @@ -1204,9 +1201,8 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the INFO Level. - * - * @return boolean - {@code true} if this Logger is enabled for level - * INFO, {@code false} otherwise. + * + * @return boolean - {@code true} if this Logger is enabled for level INFO, {@code false} otherwise. */ @Override public boolean isInfoEnabled() { @@ -1215,9 +1211,9 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the INFO Level. + * * @param marker The marker data. - * @return boolean - {@code true} if this Logger is enabled for level - * INFO, {@code false} otherwise. + * @return boolean - {@code true} if this Logger is enabled for level INFO, {@code false} otherwise. */ @Override public boolean isInfoEnabled(final Marker marker) { @@ -1225,23 +1221,20 @@ public abstract class AbstractLogger imp } /** - * Checks whether this Logger is enabled for the TRACE Level. - * - * @return boolean - {@code true} if this Logger is enabled for level - * TRACE, {@code false} otherwise. + * Checks whether this Logger is enabled for the TRACE Level. + * + * @return boolean - {@code true} if this Logger is enabled for level TRACE, {@code false} otherwise. */ @Override public boolean isTraceEnabled() { return isEnabled(Level.TRACE, null, (Object) null, null); } - /** - * Checks whether this Logger is enabled for the TRACE Level. - * + * Checks whether this Logger is enabled for the TRACE Level. + * * @param marker The marker data. - * @return boolean - {@code true} if this Logger is enabled for level - * TRACE, {@code false} otherwise. + * @return boolean - {@code true} if this Logger is enabled for level TRACE, {@code false} otherwise. */ @Override public boolean isTraceEnabled(final Marker marker) { @@ -1250,9 +1243,8 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the WARN Level. - * - * @return boolean - {@code true} if this Logger is enabled for level - * WARN, {@code false} otherwise. + * + * @return boolean - {@code true} if this Logger is enabled for level WARN, {@code false} otherwise. */ @Override public boolean isWarnEnabled() { @@ -1261,10 +1253,9 @@ public abstract class AbstractLogger imp /** * Checks whether this Logger is enabled for the WARN Level. - * + * * @param marker The marker data. - * @return boolean - {@code true} if this Logger is enabled for level - * WARN, {@code false} otherwise. + * @return boolean - {@code true} if this Logger is enabled for level WARN, {@code false} otherwise. */ @Override public boolean isWarnEnabled(final Marker marker) { @@ -1273,7 +1264,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the given level. - * + * * @param level the logging level * @param marker the marker data specific to this log statement * @param msg the message string to be logged @@ -1287,7 +1278,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the given level. - * + * * @param level the logging level * @param marker the marker data specific to this log statement. * @param msg the message string to be logged @@ -1302,7 +1293,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the given level. - * + * * @param level the logging level * @param marker the marker data specific to this log statement. * @param message the message object to log. @@ -1315,9 +1306,9 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the given level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the given level including the stack trace of the {@link Throwable} t passed as + * parameter. + * * @param level the logging level * @param marker the marker data specific to this log statement. * @param message the message to log. @@ -1332,7 +1323,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the given level. - * + * * @param level the logging level * @param marker the marker data specific to this log statement. * @param message the message object to log. @@ -1346,7 +1337,7 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the given level. - * + * * @param level the logging level * @param marker the marker data specific to this log statement. * @param message the message to log. @@ -1361,9 +1352,9 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the given level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the given level including the stack trace of the {@link Throwable} t passed as + * parameter. + * * @param level the logging level * @param marker the marker data specific to this log statement. * @param message the message to log. @@ -1378,7 +1369,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the given level. - * + * * @param level the logging level * @param msg the message string to be logged */ @@ -1391,7 +1382,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the given level. - * + * * @param level the logging level * @param msg the message string to be logged * @param t A Throwable or null. @@ -1405,7 +1396,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the given level. - * + * * @param level the logging level * @param message the message object to log. */ @@ -1417,9 +1408,9 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the given level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the given level including the stack trace of the {@link Throwable} t passed as + * parameter. + * * @param level the logging level * @param message the message to log. * @param t the exception to log, including its stack trace. @@ -1433,7 +1424,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the given level. - * + * * @param level the logging level * @param message the message object to log. */ @@ -1446,7 +1437,7 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the given level. - * + * * @param level the logging level * @param message the message to log. * @param params parameters to the message. @@ -1459,11 +1450,10 @@ public abstract class AbstractLogger imp } } - /** - * Logs a message at the given level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the given level including the stack trace of the {@link Throwable} t passed as + * parameter. + * * @param level the logging level * @param message the message to log. * @param t the exception to log, including its stack trace. @@ -1477,17 +1467,18 @@ public abstract class AbstractLogger imp /** * Logs a message with location information. - * + * * @param marker The Marker - * @param fqcn The fully qualified class name of the caller - * @param level The logging level - * @param data The Message. - * @param t A Throwable or null. + * @param fqcn The fully qualified class name of the caller + * @param level The logging level + * @param data The Message. + * @param t A Throwable or null. */ public abstract void log(Marker marker, String fqcn, Level level, Message data, Throwable t); /** * Logs a formatted message using the specified format string and arguments. + * * @param level The logging Level. * @param marker the marker data specific to this log statement. * @param format The format String. @@ -1503,6 +1494,7 @@ public abstract class AbstractLogger imp /** * Logs a formatted message using the specified format string and arguments. + * * @param level The logging Level. * @param format The format String. * @param params Arguments specified by the format. @@ -1517,10 +1509,10 @@ public abstract class AbstractLogger imp /** * Logs a Throwable to be thrown. - * + * * @param the type of the Throwable. * @param level The logging Level. - * @param t The Throwable. + * @param t The Throwable. * @return the Throwable. */ @Override @@ -1530,7 +1522,7 @@ public abstract class AbstractLogger imp /** * Logs a Throwable to be thrown with location information. - * + * * @param fqcn The fully qualified class name of the caller. * @param the type of the Throwable. * @param level The logging Level. @@ -1546,7 +1538,7 @@ public abstract class AbstractLogger imp /** * Logs a Throwable to be thrown. - * + * * @param the type of the Throwable. * @param t The Throwable. * @return the Throwable. @@ -1565,6 +1557,7 @@ public abstract class AbstractLogger imp /** * Returns a String representation of this instance in the form {@code "name"}. + * * @return A String describing this Logger instance. */ @Override @@ -1574,9 +1567,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the TRACE level. - * + * * @param marker the marker data specific to this log statement. - * @param msg the message string to be logged + * @param msg the message string to be logged */ @Override public void trace(final Marker marker, final Message msg) { @@ -1585,13 +1578,12 @@ public abstract class AbstractLogger imp } } - /** * Logs a message with the specific Marker at the TRACE level. - * + * * @param marker the marker data specific to this log statement. - * @param msg the message string to be logged - * @param t A Throwable or null. + * @param msg the message string to be logged + * @param t A Throwable or null. */ @Override public void trace(final Marker marker, final Message msg, final Throwable t) { @@ -1602,7 +1594,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#TRACE TRACE} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -1614,16 +1606,16 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#TRACE TRACE} level including the - * stack trace of the {@link Throwable} t passed as parameter. + * Logs a message at the {@link Level#TRACE TRACE} level including the stack trace of the {@link Throwable} + * t passed as parameter. *

*

* See {@link #debug(String)} form for more detailed information. *

- * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void trace(final Marker marker, final Object message, final Throwable t) { @@ -1634,7 +1626,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#TRACE TRACE} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -1647,10 +1639,10 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#TRACE TRACE} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void trace(final Marker marker, final String message, final Object... params) { @@ -1661,16 +1653,16 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#TRACE TRACE} level including the - * stack trace of the {@link Throwable} t passed as parameter. + * Logs a message at the {@link Level#TRACE TRACE} level including the stack trace of the {@link Throwable} + * t passed as parameter. *

*

* See {@link #debug(String)} form for more detailed information. *

- * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void trace(final Marker marker, final String message, final Throwable t) { @@ -1681,7 +1673,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the TRACE level. - * + * * @param msg the message string to be logged */ @Override @@ -1693,9 +1685,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the TRACE level. - * + * * @param msg the message string to be logged - * @param t A Throwable or null. + * @param t A Throwable or null. */ @Override public void trace(final Message msg, final Throwable t) { @@ -1706,7 +1698,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#TRACE TRACE} level. - * + * * @param message the message object to log. */ @Override @@ -1717,15 +1709,15 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#TRACE TRACE} level including the - * stack trace of the {@link Throwable} t passed as parameter. + * Logs a message at the {@link Level#TRACE TRACE} level including the stack trace of the {@link Throwable} + * t passed as parameter. *

*

* See {@link #debug(String)} form for more detailed information. *

- * + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void trace(final Object message, final Throwable t) { @@ -1736,7 +1728,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#TRACE TRACE} level. - * + * * @param message the message object to log. */ @Override @@ -1748,9 +1740,9 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#TRACE TRACE} level. - * + * * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void trace(final String message, final Object... params) { @@ -1761,15 +1753,15 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#TRACE TRACE} level including the - * stack trace of the {@link Throwable} t passed as parameter. + * Logs a message at the {@link Level#TRACE TRACE} level including the stack trace of the {@link Throwable} + * t passed as parameter. *

*

* See {@link #debug(String)} form for more detailed information. *

- * + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void trace(final String message, final Throwable t) { @@ -1780,9 +1772,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the WARN level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged + * @param msg the message string to be logged */ @Override public void warn(final Marker marker, final Message msg) { @@ -1793,10 +1785,10 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the WARN level. - * + * * @param marker the marker data specific to this log statement - * @param msg the message string to be logged - * @param t A Throwable or null. + * @param msg the message string to be logged + * @param t A Throwable or null. */ @Override public void warn(final Marker marker, final Message msg, final Throwable t) { @@ -1807,7 +1799,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#WARN WARN} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -1819,18 +1811,17 @@ public abstract class AbstractLogger imp } /* - * Instead of one single method with Object... declared the following methods explicitly specify - * parameters because they perform dramatically better than having the JVM convert them to an - * array. + * Instead of one single method with Object... declared the following methods explicitly specify parameters because + * they perform dramatically better than having the JVM convert them to an array. */ /** - * Logs a message at the {@link Level#WARN WARN} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#WARN WARN} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void warn(final Marker marker, final Object message, final Throwable t) { @@ -1841,7 +1832,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#WARN WARN} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message object to log. */ @@ -1854,10 +1845,10 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#WARN WARN} level. - * + * * @param marker the marker data specific to this log statement. * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void warn(final Marker marker, final String message, final Object... params) { @@ -1868,12 +1859,12 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#WARN WARN} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#WARN WARN} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param marker the marker data specific to this log statement. * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void warn(final Marker marker, final String message, final Throwable t) { @@ -1884,7 +1875,7 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the WARN level. - * + * * @param msg the message string to be logged */ @Override @@ -1896,9 +1887,9 @@ public abstract class AbstractLogger imp /** * Logs a message with the specific Marker at the WARN level. - * + * * @param msg the message string to be logged - * @param t A Throwable or null. + * @param t A Throwable or null. */ @Override public void warn(final Message msg, final Throwable t) { @@ -1909,7 +1900,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#WARN WARN} level. - * + * * @param message the message object to log. */ @Override @@ -1920,11 +1911,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#WARN WARN} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#WARN WARN} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void warn(final Object message, final Throwable t) { @@ -1935,7 +1926,7 @@ public abstract class AbstractLogger imp /** * Logs a message object with the {@link Level#WARN WARN} level. - * + * * @param message the message object to log. */ @Override @@ -1947,9 +1938,9 @@ public abstract class AbstractLogger imp /** * Logs a message with parameters at the {@link Level#WARN WARN} level. - * + * * @param message the message to log. - * @param params parameters to the message. + * @param params parameters to the message. */ @Override public void warn(final String message, final Object... params) { @@ -1960,11 +1951,11 @@ public abstract class AbstractLogger imp } /** - * Logs a message at the {@link Level#WARN WARN} level including the - * stack trace of the {@link Throwable} t passed as parameter. - * + * Logs a message at the {@link Level#WARN WARN} level including the stack trace of the {@link Throwable} + * t passed as parameter. + * * @param message the message object to log. - * @param t the exception to log, including its stack trace. + * @param t the exception to log, including its stack trace. */ @Override public void warn(final String message, final Throwable t) {