javadoc updates
[utils] / test / enterprise / src / main / java / org / wamblee / support / persistence / CompositeJpaTables.java
index 7a7e8de6c8a9b3933988bb0deca1519fa4c76fd0..b44ff7cce56e52ca6ae8622772782b9eaa7613aa 100644 (file)
@@ -1,3 +1,18 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * 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.support.persistence;
 
 import java.util.ArrayList;
@@ -6,26 +21,38 @@ import java.util.List;
 import org.dbunit.dataset.DataSetException;
 import org.dbunit.dataset.filter.ITableFilterSimple;
 
+/**
+ * Composite JPA tables. Implements the logical or of several table filters. 
+ * 
+ * @author Erik Brakkee
+ */
 public class CompositeJpaTables implements ITableFilterSimple {
-    
-    private List<ITableFilterSimple> _tables; 
-    
-    public CompositeJpaTables() { 
-        _tables = new ArrayList<ITableFilterSimple>();
+
+    private List<ITableFilterSimple> tables;
+
+    /**
+     * Construcst the tables. 
+     */
+    public CompositeJpaTables() {
+        tables = new ArrayList<ITableFilterSimple>();
     }
-    
-    public void add(ITableFilterSimple aFilter) { 
-        _tables.add(aFilter);
+
+    /**
+     * Adds a table filter. 
+     * @param aFilter filter. 
+     */
+    public void add(ITableFilterSimple aFilter) {
+        tables.add(aFilter);
     }
 
     @Override
     public boolean accept(String aTableName) throws DataSetException {
-        for (ITableFilterSimple filter: _tables) { 
-            if (filter.accept(aTableName)) { 
-                return true; 
+        for (ITableFilterSimple filter : tables) {
+            if (filter.accept(aTableName)) {
+                return true;
             }
         }
-        return false; 
+        return false;
     }
 
 }