You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by ca...@apache.org on 2010/05/17 06:22:30 UTC
svn commit: r944962 - in /logging/log4j/companions/extras/trunk/src:
changes/changes.xml main/java/org/apache/log4j/LogMF.java
main/java/org/apache/log4j/LogSF.java main/java/org/apache/log4j/LogXF.java
Author: carnold
Date: Mon May 17 04:22:30 2010
New Revision: 944962
URL: http://svn.apache.org/viewvc?rev=944962&view=rev
Log:
Bug 49812: Improve javadoc for LogMF, LogSF, LogXF
Modified:
logging/log4j/companions/extras/trunk/src/changes/changes.xml
logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogMF.java
logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogSF.java
logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogXF.java
Modified: logging/log4j/companions/extras/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/changes/changes.xml?rev=944962&r1=944961&r2=944962&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/changes/changes.xml (original)
+++ logging/log4j/companions/extras/trunk/src/changes/changes.xml Mon May 17 04:22:30 2010
@@ -34,6 +34,7 @@
<action action="fix" issue="48927">EnhancedPatternLayout tests conflict with PatternLayout tests.</action>
<action action="add" issue="49010">Add %p{-2} pattern to EnhancedPatternLayout to drop two leading elements from name.</action>
<action action="add" issue="48902">Add %throwable{n} and {-n} pattern to EnhancedPatternLayout to print n or drop last n lines.</action>
+ <action action="fix" issue="49812">Improve javadoc for LogMF, LogSF, LogXF</action>
</release>
Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogMF.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogMF.java?rev=944962&r1=944961&r2=944962&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogMF.java (original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogMF.java Mon May 17 04:22:30 2010
@@ -27,8 +27,19 @@ import java.util.Locale;
/**
- * This class provides static methods to
- * format log messages using java.text.MessageFormat.
+ * This class provides parameterized logging services
+ * using the pattern syntax of java.text.MessageFormat.
+ * Message formatting is only performed when the
+ * request exceeds the threshold level of the logger.
+ * When the pattern only contains literal text and
+ * default conversion patterns (that is "{0}" and similar)
+ * a simple fast compatible formatter is used.
+ * If the pattern contains more complex conversion patterns,
+ * formatting will be delegated to java.text.MessageFormatter
+ * which can be substantially slower.
+ *
+ * @see org.apache.log4j.LogSF
+ * @since 1.2.16
*
*/
public final class LogMF extends LogXF {
Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogSF.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogSF.java?rev=944962&r1=944961&r2=944962&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogSF.java (original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogSF.java Mon May 17 04:22:30 2010
@@ -22,9 +22,13 @@ import java.util.ResourceBundle;
/**
- * This class provides static methods to
- * format log messages using a log4j 1.3 or SLF4J
- * style formatter.
+ * This class provides parameterized logging services
+ * using the SLF4J pattern syntax.
+ * <p>
+ * Message formatting is only performed when the
+ * request exceeds the threshold level of the logger.
+ *
+ * @since 1.2.16
*
*/
public final class LogSF extends LogXF {
Modified: logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogXF.java
URL: http://svn.apache.org/viewvc/logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogXF.java?rev=944962&r1=944961&r2=944962&view=diff
==============================================================================
--- logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogXF.java (original)
+++ logging/log4j/companions/extras/trunk/src/main/java/org/apache/log4j/LogXF.java Mon May 17 04:22:30 2010
@@ -18,7 +18,15 @@ package org.apache.log4j;
import org.apache.log4j.spi.LoggingEvent;
-public class LogXF {
+/**
+ * This is a base class for LogMF and LogSF parameterized logging classes.
+ *
+ *
+ * @see org.apache.log4j.LogMF
+ * @see org.apache.log4j.LogSF
+ * @since 1.2.16
+ */
+public abstract class LogXF {
/**
* Trace level.
*/
@@ -188,7 +196,6 @@ public class LogXF {
* @param logger logger, may not be null.
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
- * @since 1.1
*/
public static void entering(final Logger logger,
final String sourceClass,
@@ -206,7 +213,6 @@ public class LogXF {
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
* @param param parameter, may be null.
- * @since 1.1
*/
public static void entering(final Logger logger,
final String sourceClass,
@@ -226,7 +232,6 @@ public class LogXF {
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
* @param param parameter, may be null.
- * @since 1.1
*/
public static void entering(final Logger logger,
final String sourceClass,
@@ -255,7 +260,6 @@ public class LogXF {
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
* @param params parameters, may be null.
- * @since 1.1
*/
public static void entering(final Logger logger,
final String sourceClass,
@@ -288,7 +292,6 @@ public class LogXF {
* @param logger logger, may not be null.
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
- * @since 1.1
*/
public static void exiting(final Logger logger,
final String sourceClass,
@@ -306,7 +309,6 @@ public class LogXF {
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
* @param result result, may be null.
- * @since 1.1
*/
public static void exiting(
final Logger logger,
@@ -326,7 +328,6 @@ public class LogXF {
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
* @param result result, may be null.
- * @since 1.1
*/
public static void exiting(
final Logger logger,
@@ -355,9 +356,7 @@ public class LogXF {
* @param logger logger, may not be null.
* @param sourceClass source class, may be null.
* @param sourceMethod method, may be null.
- * @param thrown, throwable may be null.
- * @param thrown the throwable.
- * @since 1.1
+ * @param thrown throwable, may be null.
*/
public static void throwing(
final Logger logger,
---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org