[jbpm-commits] JBoss JBPM SVN: r4411 - jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter.

[do-not-reply at jboss.org]

Author: bradsdavis
Date: 2009-04-03 11:06:10 -0400 (Fri, 03 Apr 2009)
New Revision: 4411

Modified:
   jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/AddressFilter.java
   jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/WildCardAddressFilter.java
Log:
Added comments.

Modified: jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/AddressFilter.java
===================================================================
--- jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/AddressFilter.java	2009-04-03 15:03:51 UTC (rev 4410)
+++ jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/AddressFilter.java	2009-04-03 15:06:10 UTC (rev 4411)
@@ -6,7 +6,7 @@
 
 public interface AddressFilter {
 	/**
-	 * This method should remove 
+	 * This method should remove addresses from to, cc, and bcc based on the filter implementation.
 	 * 
 	 * @param to To addresses for the email.
 	 * @param cc CC addresses for the email.

Modified: jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/WildCardAddressFilter.java
===================================================================
--- jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/WildCardAddressFilter.java	2009-04-03 15:03:51 UTC (rev 4410)
+++ jbpm4/branches/email/modules/pvm/src/main/java/org/jbpm/pvm/internal/email/filter/WildCardAddressFilter.java	2009-04-03 15:06:10 UTC (rev 4411)
@@ -57,6 +57,11 @@
 		if(bcc!=null)bcc.removeAll(toRemove);
 	}
 	
+	/***
+	 * Determine in a given address is included or excluded based on regex.
+	 * @param address Email Address to validate against regex.
+	 * @return If the includes is provided, and the address matches an include pattern, returns true, false otherwise.
+	 */
 	private boolean keepAddress(InternetAddress address)
 	{	
 		if(includePatterns!=null)