(no commit message)

[utils] / support / general / src / main / java / org / wamblee / collections / CollectionFilter.java

diff --git a/support/general/src/main/java/org/wamblee/collections/CollectionFilter.java b/support/general/src/main/java/org/wamblee/collections/CollectionFilter.java
index c52bf7b15a49831e6d431db4e58bff97e3904110..cbf9e47ae0e05d6d1a43379ab57c510d294fa1d9 100644 (file)
--- a/support/general/src/main/java/org/wamblee/collections/CollectionFilter.java
+++ b/support/general/src/main/java/org/wamblee/collections/CollectionFilter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008 the original author or authors.
+ * Copyright 2005-2010 the original author or authors.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,21 +12,38 @@
  * 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.collections;
 
-import java.util.Collection;
-
 import org.wamblee.conditions.Condition;
 
-public class CollectionFilter {
+import java.util.Collection;
 
-       public static <T> void filter(Collection<T> aFrom, Collection<T> aTo, Condition<T> aCondition) { 
-               for (T t: aFrom) { 
-                       if ( aCondition.matches(t)) { 
-                               aTo.add(t);
-                       }
-               }
-       }
-       
+/**
+ * Collection filter for filtering collections based on a certain condition.
+ * 
+ * @author Erik Brakkee
+ */
+public class CollectionFilter {
+    /**
+     * Filters a collection by adding all elements in the from collection that
+     * satisfy a given condition to the to collection.
+     * 
+     * @param <T>
+     *            Type of contained element.
+     * @param aFrom
+     *            From container to which the condition is applied.
+     * @param aTo
+     *            To container to which matching elements are added.
+     * @param aCondition
+     *            Condition by which elements are matched.
+     */
+    public static <T> void filter(Collection<T> aFrom, Collection<T> aTo,
+        Condition<T> aCondition) {
+        for (T t : aFrom) {
+            if (aCondition.matches(t)) {
+                aTo.add(t);
+            }
+        }
+    }
 }