[LOGBack-dev] svn commit: r307 - logback/core/trunk/src/main/java/ch/qos/logback/core/filter

[noreply.seb at qos.ch]

Author: seb
Date: Tue Jul 25 15:41:29 2006
New Revision: 307

Modified:
   logback/core/trunk/src/main/java/ch/qos/logback/core/filter/AbstractEvalutatorFilter.java
Log:
added some javadoc

Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/filter/AbstractEvalutatorFilter.java
==============================================================================
--- logback/core/trunk/src/main/java/ch/qos/logback/core/filter/AbstractEvalutatorFilter.java	(original)
+++ logback/core/trunk/src/main/java/ch/qos/logback/core/filter/AbstractEvalutatorFilter.java	Tue Jul 25 15:41:29 2006
@@ -1,5 +1,24 @@
 package ch.qos.logback.core.filter;
 
+/**
+ * <p>
+ * This abstract class is meant to be a base for specific evaluator filters.
+ * </p>
+ * <p>
+ * The value of the {@link #onMatch} and {@link #onMismatch} attributes is set to 
+ * {@link Filter.NEUTRAL}, so that a badly configured evaluator filter doesn't 
+ * disturb the functionning of the chain.
+ * </p>
+ * <p>
+ * It is expected that one of the two attributes will have its value changed to
+ * {@link Filter.ACCEPT} or {@link Filter.DENY}. That way, it is possible to decide if 
+ * a given result must be returned after the evaluation either failed or succeeded.
+ * </p>
+ * 
+ * @author Ceki G&uuml;lc&uuml;
+ *
+ */
+
 abstract public class AbstractEvalutatorFilter extends Filter {
 
   int onMatch = NEUTRAL;