svn commit: r1340758 - /creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java

[rd...@apache.org]

Author: rdonkin
Date: Sun May 20 16:03:53 2012
New Revision: 1340758

URL: http://svn.apache.org/viewvc?rev=1340758&view=rev
Log:
More documentation

Modified:
    creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java

Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java?rev=1340758&r1=1340757&r2=1340758&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java Sun May 20 16:03:53 2012
@@ -14,42 +14,84 @@
  * "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. 
+ * under the License.
  */
 package org.apache.creadur.whisker.model;
 
 /**
- * 
+ * Visits element in the model.
  */
 public abstract class Visitor {
 
-    // Tune traversal
+    /**
+     * Tunes traversal, allowing public domain resources
+     * to be ignored.
+     * @return true when public domain resources should
+     * be traversed, false otherwise
+     */
     public boolean traversePublicDomain() {
         return true;
     }
 
+    /**
+     * Tunes traversal, allowing a shallow traversal
+     * without {@link WithLicense} elements.
+     *
+     * @return true when {@link WithLicense} elements
+     * should be stepped over, false when they should
+     * be included
+     */
     public boolean traverseWithLicense() {
         return true;
     }
 
+    /**
+     * Tunes traversal, allowing a moderate traversal
+     * without {@link ByOrganisation} elements.
+     * @return true when {@link ByOrganisation} elements
+     * should be stepped over, false when they should
+     * be included
+     */
     public boolean traverseByOrganisation() {
         return true;
     }
 
+    /**
+     * Tunes traversal, allowing {@link Resource}
+     * elements to be ignored.
+     * @return true when {@link Resource} elements
+     * should be stepped over, false when they should
+     * be included
+     */
     public boolean traverseResource() {
         return true;
     }
 
-    // Classic visitor pattern
+    /**
+     * Visits {@link WithinDirectory}.
+     * @param directory not null
+     */
     public void visit(final WithinDirectory directory) {
     };
 
+    /**
+     * Visits {@link WithLicense}.
+     * @param license not null
+     */
     public void visit(final WithLicense license) {
     };
 
+    /**
+     * Visits {@link ByOrganisation}.
+     * @param byOrganisation not null
+     */
     public void visit(final ByOrganisation byOrganisation) {
     };
 
+    /**
+     * Visits {@link Resource}.
+     * @param resource not null
+     */
     public void visit(final Resource resource) {
     };
 }