You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rp...@apache.org on 2016/11/08 13:04:33 UTC

logging-log4j2 git commit: LOG4J2-1590 javadoc

Repository: logging-log4j2
Updated Branches:
  refs/heads/master 807426d4f -> 4db2f5ab1


LOG4J2-1590 javadoc


Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/4db2f5ab
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/4db2f5ab
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/4db2f5ab

Branch: refs/heads/master
Commit: 4db2f5ab14e149e7d2db5e75ca36fc10980af168
Parents: 807426d
Author: rpopma <rp...@apache.org>
Authored: Tue Nov 8 22:04:28 2016 +0900
Committer: rpopma <rp...@apache.org>
Committed: Tue Nov 8 22:04:28 2016 +0900

----------------------------------------------------------------------
 .../logging/log4j/core/filter/AbstractFilter.java   | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/4db2f5ab/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/AbstractFilter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/AbstractFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/AbstractFilter.java
index a6051ad..00807ec 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/AbstractFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/AbstractFilter.java
@@ -28,6 +28,12 @@ import org.apache.logging.log4j.message.Message;
  * Users should extend this class to implement filters. Filters can be either context wide or attached to
  * an appender. A filter may choose to support being called only from the context or only from an appender in
  * which case it will only implement the required method(s). The rest will default to return {@link Result#NEUTRAL}.
+ * <p>
+ * Garbage-free note: the methods with unrolled varargs by default delegate to the
+ * {@link #filter(Logger, Level, Marker, String, Object...) filter method with vararg parameters}.
+ * Subclasses that want to be garbage-free should override these methods to implement the appropriate filtering
+ * without creating a vararg array.
+ * </p>
  */
 public abstract class AbstractFilter extends AbstractLifeCycle implements Filter {
 
@@ -142,6 +148,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param msg The message, if present.
      * @param p0 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -158,6 +165,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p0 the message parameters
      * @param p1 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -175,6 +183,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p1 the message parameters
      * @param p2 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -193,6 +202,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p2 the message parameters
      * @param p3 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -212,6 +222,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p3 the message parameters
      * @param p4 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -233,6 +244,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p4 the message parameters
      * @param p5 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -255,6 +267,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p5 the message parameters
      * @param p6 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -278,6 +291,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p6 the message parameters
      * @param p7 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -303,6 +317,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p7 the message parameters
      * @param p8 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
@@ -329,6 +344,7 @@ public abstract class AbstractFilter extends AbstractLifeCycle implements Filter
      * @param p8 the message parameters
      * @param p9 the message parameters
      * @return The Result of filtering.
+     * @since 2.7
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,