From droids-commits-return-545-apmail-incubator-droids-commits-archive=incubator.apache.org@incubator.apache.org  Fri Mar  1 09:04:50 2013
Return-Path: <droids-commits-return-545-apmail-incubator-droids-commits-archive=incubator.apache.org@incubator.apache.org>
X-Original-To: apmail-incubator-droids-commits-archive@minotaur.apache.org
Delivered-To: apmail-incubator-droids-commits-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id DFB5CD30E
	for <apmail-incubator-droids-commits-archive@minotaur.apache.org>; Fri,  1 Mar 2013 09:04:49 +0000 (UTC)
Received: (qmail 1260 invoked by uid 500); 1 Mar 2013 09:04:49 -0000
Delivered-To: apmail-incubator-droids-commits-archive@incubator.apache.org
Received: (qmail 1151 invoked by uid 500); 1 Mar 2013 09:04:46 -0000
Mailing-List: contact droids-commits-help@incubator.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:droids-commits-help@incubator.apache.org>
List-Unsubscribe: <mailto:droids-commits-unsubscribe@incubator.apache.org>
List-Post: <mailto:droids-commits@incubator.apache.org>
List-Id: <droids-commits.incubator.apache.org>
Reply-To: droids-dev@incubator.apache.org
Delivered-To: mailing list droids-commits@incubator.apache.org
Received: (qmail 1099 invoked by uid 99); 1 Mar 2013 09:04:44 -0000
Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 01 Mar 2013 09:04:44 +0000
X-ASF-Spam-Status: No, hits=-2000.0 required=5.0
	tests=ALL_TRUSTED
X-Spam-Check-By: apache.org
Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 01 Mar 2013 09:04:41 +0000
Received: from eris.apache.org (localhost [127.0.0.1])
	by eris.apache.org (Postfix) with ESMTP id 2EB112388980;
	Fri,  1 Mar 2013 09:04:21 +0000 (UTC)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1451536 -
 /incubator/droids/branches/0.2.x-cleanup/droids-core/src/main/java/org/apache/droids/filter/RegexURLFilter.java
Date: Fri, 01 Mar 2013 09:04:21 -0000
To: droids-commits@incubator.apache.org
From: tobr@apache.org
X-Mailer: svnmailer-1.0.8-patched
Message-Id: <20130301090421.2EB112388980@eris.apache.org>
X-Virus-Checked: Checked by ClamAV on apache.org

Author: tobr
Date: Fri Mar  1 09:04:20 2013
New Revision: 1451536

URL: http://svn.apache.org/r1451536
Log:
added rules reader from inputstream
https://issues.apache.org/jira/browse/DROIDS-98

added documentation

Modified:
    incubator/droids/branches/0.2.x-cleanup/droids-core/src/main/java/org/apache/droids/filter/RegexURLFilter.java

Modified: incubator/droids/branches/0.2.x-cleanup/droids-core/src/main/java/org/apache/droids/filter/RegexURLFilter.java
URL: http://svn.apache.org/viewvc/incubator/droids/branches/0.2.x-cleanup/droids-core/src/main/java/org/apache/droids/filter/RegexURLFilter.java?rev=1451536&r1=1451535&r2=1451536&view=diff
==============================================================================
--- incubator/droids/branches/0.2.x-cleanup/droids-core/src/main/java/org/apache/droids/filter/RegexURLFilter.java (original)
+++ incubator/droids/branches/0.2.x-cleanup/droids-core/src/main/java/org/apache/droids/filter/RegexURLFilter.java Fri Mar  1 09:04:20 2013
@@ -16,10 +16,7 @@
  */
 package org.apache.droids.filter;
 
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.Reader;
+import java.io.*;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.List;
@@ -31,8 +28,8 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Regular expression implementation of an UrlFilter. Evaluates the url based on
- * regular expression.
+ * Regular expression implementation of an UrlFilter.
+ * Evaluates the url based on regular expression.
  *
  * @version 1.0
  */
@@ -82,10 +79,12 @@ public class RegexURLFilter<T extends Ta
     }
 
     /**
-     * @param file
+     * Add rules provided by file.
+     *
+     * @param file the path to the file
      * @throws IOException
      */
-    public void setFile(String file) throws IOException {
+    public void addRulesFile(String file) throws IOException {
         URL url = null;
         if (file.startsWith("classpath:/")) {
             url = this.getClass().getResource(file.substring("classpath:/".length() - 1));
@@ -101,6 +100,25 @@ public class RegexURLFilter<T extends Ta
         }
     }
 
+    /**
+     * Add rules from an inputstream of a rules file.
+     *
+     * @param is the inputstream of a file with rules
+     * @throws IOException
+     */
+    public void addRulesFile(InputStream is) throws IOException {
+        Reader reader = new InputStreamReader(is);
+        rules.addAll(readRulesFile(reader));
+    }
+
+    /**
+     * Extract the regex rules from a reader and
+     * add the to the filter.
+     *
+     * @param reader the rules reader
+     * @return a list of regex rules
+     * @throws IOException
+     */
     private List<RegexRule> readRulesFile(Reader reader) throws IOException {
         BufferedReader in = new BufferedReader(reader);
         List<RegexRule> localRules = new ArrayList<RegexRule>(16);
@@ -138,10 +156,20 @@ public class RegexURLFilter<T extends Ta
 
     }
 
+    /**
+     * Create a new regex rule.
+     *
+     * @param sign boolean value to define the filtering in or out.
+     * @param regex the rules regex
+     * @return
+     */
     private static RegexRule createRule(boolean sign, String regex) {
         return new Rule(sign, regex);
     }
 
+    /**
+     * Implementation of {@link RegexRule}
+     */
     private static class Rule extends RegexRule {
 
         private Pattern pattern;