logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1396210 - /logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
Date Tue, 09 Oct 2012 19:17:46 GMT
Author: ggregory
Date: Tue Oct  9 19:17:45 2012
New Revision: 1396210

URL: http://svn.apache.org/viewvc?rev=1396210&view=rev
Log:
Javadoc.

Modified:
    logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java

Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java?rev=1396210&r1=1396209&r2=1396210&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
(original)
+++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/filter/CompositeFilter.java
Tue Oct  9 19:17:45 2012
@@ -34,7 +34,7 @@ import java.util.Iterator;
 import java.util.List;
 
 /**
- * Filter that invokes multiple filters.
+ * Composes and invokes one or more filters.
  */
 @Plugin(name = "filters", type = "Core", printObject = true)
 public final class CompositeFilter implements Iterable<Filter>, Filter, Lifecycle {
@@ -111,13 +111,16 @@ public final class CompositeFilter imple
 
     /**
      * Return the result that should be returned when the filter does not match the event.
+     * 
      * @return the Result that should be returned when the filter does not match the event.
      */
     public Result getOnMismatch() {
         return Result.NEUTRAL;
     }
+
     /**
      * Return the result that should be returned when the filter matches the event.
+     * 
      * @return the Result that should be returned when the filter matches the event.
      */
     public Result getOnMatch() {
@@ -126,11 +129,17 @@ public final class CompositeFilter imple
 
     /**
      * Filter an event.
-     * @param logger The Logger.
-     * @param level The event logging Level.
-     * @param marker The Marker for the event or null.
-     * @param msg String text to filter on.
-     * @param params An array of parameters or null.
+     * 
+     * @param logger
+     *            The Logger.
+     * @param level
+     *            The event logging Level.
+     * @param marker
+     *            The Marker for the event or null.
+     * @param msg
+     *            String text to filter on.
+     * @param params
+     *            An array of parameters or null.
      * @return the Result.
      */
     public Result filter(Logger logger, Level level, Marker marker, String msg, Object...
params) {
@@ -146,11 +155,17 @@ public final class CompositeFilter imple
 
     /**
      * Filter an event.
-     * @param logger The Logger.
-     * @param level The event logging Level.
-     * @param marker The Marker for the event or null.
-     * @param msg Any Object.
-     * @param t A Throwable or null.
+     * 
+     * @param logger
+     *            The Logger.
+     * @param level
+     *            The event logging Level.
+     * @param marker
+     *            The Marker for the event or null.
+     * @param msg
+     *            Any Object.
+     * @param t
+     *            A Throwable or null.
      * @return the Result.
      */
     public Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable
t) {
@@ -166,11 +181,17 @@ public final class CompositeFilter imple
 
     /**
      * Filter an event.
-     * @param logger The Logger.
-     * @param level The event logging Level.
-     * @param marker The Marker for the event or null.
-     * @param msg The Message
-     * @param t A Throwable or null.
+     * 
+     * @param logger
+     *            The Logger.
+     * @param level
+     *            The event logging Level.
+     * @param marker
+     *            The Marker for the event or null.
+     * @param msg
+     *            The Message
+     * @param t
+     *            A Throwable or null.
      * @return the Result.
      */
     public Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable
t) {
@@ -186,7 +207,9 @@ public final class CompositeFilter imple
 
     /**
      * Filter an event.
-     * @param event The Event to filter on.
+     * 
+     * @param event
+     *            The Event to filter on.
      * @return the Result.
      */
     public Result filter(LogEvent event) {
@@ -219,7 +242,9 @@ public final class CompositeFilter imple
 
     /**
      * Create a CompositeFilter.
-     * @param filters An array of Filters to call.
+     * 
+     * @param filters
+     *            An array of Filters to call.
      * @return The CompositeFilter.
      */
     @PluginFactory



Mime
View raw message