commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1135473 - /commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/filter/Filter.java
Date Tue, 14 Jun 2011 10:53:04 GMT
Author: simonetripodi
Date: Tue Jun 14 10:53:04 2011
New Revision: 1135473

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

Modified:
    commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/filter/Filter.java

Modified: commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/filter/Filter.java
URL: http://svn.apache.org/viewvc/commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/filter/Filter.java?rev=1135473&r1=1135472&r2=1135473&view=diff
==============================================================================
--- commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/filter/Filter.java
(original)
+++ commons/sandbox/meiyo/trunk/src/main/java/org/apache/commons/meiyo/classpath/filter/Filter.java
Tue Jun 14 10:53:04 2011
@@ -20,28 +20,76 @@ package org.apache.commons.meiyo.classpa
  */
 
 /**
- * A filter is a class, found in the classpath, discriminator.
+ * A {@code Filter} is a class, found in the ClassPath, discriminator.
  */
 public interface Filter
 {
 
     /**
      * Returns {@code true} if the given class satisfies the requirements, {@code false}
otherwise.
-     * 
+     *
      * @return {@code true} if the given class satisfies the requirements, {@code false}
otherwise.
      */
     boolean matches( Class<?> clazz );
 
+    /**
+     * Returns a new {@code Filter} which returns {@code true} if either this
+     * <b>and</b> the given {@code Filter} return {@code true}.
+     *
+     * @param other the other Filter instance that participate in this predicate.
+     * @return a new {@code Filter} which returns {@code true} if either this
+     *          <b>and</b> the given {@code Filter} return {@code true}.
+     */
     Filter and( Filter other );
 
+    /**
+     * Returns a new {@code Filter} which returns {@code true} if either this
+     * <b>nand</b> the given {@code Filter} return {@code true}.
+     *
+     * @param other the other Filter instance that participate in this predicate.
+     * @return a new {@code Filter} which returns {@code true} if either this
+     *         <b>nand</b> the given {@code Filter} return {@code true}.
+     */
     Filter nand( Filter other );
 
+    /**
+     * Returns a new {@code Filter} which returns {@code true} if either this
+     * <b>or</b> the given {@code Filter} return {@code true}.
+     *
+     * @param other the other Filter instance that participate in this predicate.
+     * @return a new {@code Filter} which returns {@code true} if either this
+     *         <b>or</b> the given {@code Filter} return {@code true}.
+     */
     Filter or( Filter other );
 
+    /**
+     * Returns a new {@code Filter} which returns {@code true} if either this
+     * <b>nor</b> the given {@code Filter} return {@code true}.
+     *
+     * @param other the other Filter instance that participate in this predicate.
+     * @return a new {@code Filter} which returns {@code true} if either this
+     *         <b>nor</b> the given {@code Filter} return {@code true}.
+     */
     Filter nor( Filter other );
 
+    /**
+     * Returns a new {@code Filter} which returns {@code true} if either this
+     * <b>xor</b> the given {@code Filter} return {@code true}.
+     *
+     * @param other the other Filter instance that participate in this predicate.
+     * @return a new {@code Filter} which returns {@code true} if either this
+     *         <b>xor</b> the given {@code Filter} return {@code true}.
+     */
     Filter xor( Filter other );
 
+    /**
+     * Returns a new {@code Filter} which returns {@code true} if either this
+     * <b>xnor</b> the given {@code Filter} return {@code true}.
+     *
+     * @param other the other Filter instance that participate in this predicate.
+     * @return a new {@code Filter} which returns {@code true} if either this
+     *         <b>xnor</b> the given {@code Filter} return {@code true}.
+     */
     Filter xnor( Filter other );
 
 }



Mime
View raw message