commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1135284 - in /commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath: AbstractHandlerConfiguration.java Matcher.java
Date Mon, 13 Jun 2011 21:12:10 GMT
Author: simonetripodi
Date: Mon Jun 13 21:12:09 2011
New Revision: 1135284

URL: http://svn.apache.org/viewvc?rev=1135284&view=rev
Log:
added missing javadoc

Modified:
    commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/AbstractHandlerConfiguration.java
    commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/Matcher.java

Modified: commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/AbstractHandlerConfiguration.java
URL: http://svn.apache.org/viewvc/commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/AbstractHandlerConfiguration.java?rev=1135284&r1=1135283&r2=1135284&view=diff
==============================================================================
--- commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/AbstractHandlerConfiguration.java
(original)
+++ commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/AbstractHandlerConfiguration.java
Mon Jun 13 21:12:09 2011
@@ -22,7 +22,8 @@ package org.apache.commons.meiyo.classpa
 import org.apache.commons.meiyo.classpath.filter.Filter;
 
 /**
- * FILL ME
+ * A support class for {@link HandlerConfiguration} which reduces repetition and results
+ * in a more readable configuration.
  */
 public abstract class AbstractHandlerConfiguration
     implements HandlerConfiguration
@@ -51,11 +52,21 @@ public abstract class AbstractHandlerCon
         }
     }
 
+    /**
+     * Allows to associate the given filter to one or more {@link ClassPathEntryHandler}.
+     *
+     * @param filter The filter that ClassPath entry should match
+     * @return the {@link ClassPathEntryHandler} builder
+     * @see Matcher#ifMatches(Filter)
+     */
     protected LinkedHandlerBuilder ifMatches( Filter filter )
     {
         return wrapped.ifMatches( filter );
     }
 
+    /**
+     * Configures a {@link Matcher} via the exposed methods.
+     */
     public abstract void configure();
 
 }

Modified: commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/Matcher.java
URL: http://svn.apache.org/viewvc/commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/Matcher.java?rev=1135284&r1=1135283&r2=1135284&view=diff
==============================================================================
--- commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/Matcher.java
(original)
+++ commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/Matcher.java
Mon Jun 13 21:12:09 2011
@@ -22,11 +22,17 @@ package org.apache.commons.meiyo.classpa
 import org.apache.commons.meiyo.classpath.filter.Filter;
 
 /**
- * FILL ME
+ * The ClassPath scanning EDSL.
  */
 public interface Matcher
 {
 
+    /**
+     * Allows to associate the given filter to one or more {@link ClassPathEntryHandler}.
+     *
+     * @param filter The filter that ClassPath entry should match
+     * @return the {@link ClassPathEntryHandler} builder
+     */
     LinkedHandlerBuilder ifMatches( Filter filter );
 
 }



Mime
View raw message