refactoring of the config interface towards more reuse in the implementation and...

[xmlrouter] / config / src / main / java / org / wamblee / xmlrouter / config / Filter.java

diff --git a/config/src/main/java/org/wamblee/xmlrouter/config/Filter.java b/config/src/main/java/org/wamblee/xmlrouter/config/Filter.java
index 3f329713a779dbc7e086438447fbcf9e5e0a161c..212c65f90162b0f5ae0507b6c278c7ca5d3ab694 100644 (file)
--- a/config/src/main/java/org/wamblee/xmlrouter/config/Filter.java
+++ b/config/src/main/java/org/wamblee/xmlrouter/config/Filter.java
@@ -12,16 +12,25 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
+ */
 package org.wamblee.xmlrouter.config;
 
 import javax.xml.transform.dom.DOMSource;
 
+/**
+ * Represents a custom filter that is used to determine whether or not a certain
+ * event is allowed or not.
+ * 
+ * @author Erik Brakkee
+ * 
+ */
 public interface Filter {
 
     /**
-     * Determines if a given document will be processed or not. 
-     * @param aSource Source document. 
+     * Determines if a given document will be processed or not.
+     * 
+     * @param aSource
+     *            Source document.
      * @return
      */
     boolean isAllowed(String aDocumentType, DOMSource aSource);