Author: tn
Date: Thu Jul 26 19:53:10 2012
New Revision: 1366175
URL: http://svn.apache.org/viewvc?rev=1366175&view=rev
Log:
Javadoc fixes for predicates.
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/FalsePredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/IdentityPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NonePredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotNullPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsExceptionPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsFalsePredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsTruePredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OnePredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OrPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformedPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformerPredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TruePredicate.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/UniquePredicate.java
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/FalsePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/FalsePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/FalsePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/FalsePredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class FalsePredicate<T> imp
/**
* Get a typed instance.
*
+ * @param <T> the type that the predicate queries
* @return the singleton instance
* @since 4.0
*/
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/IdentityPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/IdentityPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/IdentityPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/IdentityPredicate.java
Thu Jul 26 19:53:10 2012
@@ -38,6 +38,7 @@ public final class IdentityPredicate<T>
/**
* Factory to create the identity predicate.
*
+ * @param <T> the type that the predicate queries
* @param object the object to compare to
* @return the predicate
* @throws IllegalArgumentException if the predicate is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NonePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NonePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NonePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NonePredicate.java
Thu Jul 26 19:53:10 2012
@@ -45,6 +45,7 @@ public final class NonePredicate<T> impl
* <p>
* If the array is size zero, the predicate always returns true.
*
+ * @param <T> the type that the predicate queries
* @param predicates the predicates to check, cloned, not null
* @return the <code>any</code> predicate
* @throws IllegalArgumentException if the predicates array is null
@@ -63,6 +64,7 @@ public final class NonePredicate<T> impl
* <p>
* If the collection is size zero, the predicate always returns true.
*
+ * @param <T> the type that the predicate queries
* @param predicates the predicates to check, cloned, not null
* @return the <code>one</code> predicate
* @throws IllegalArgumentException if the predicates array is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotNullPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotNullPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotNullPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotNullPredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class NotNullPredicate<T> i
/**
* Factory returning the singleton instance.
*
+ * @param <T> the type that the predicate queries
* @return the singleton instance
* @since 3.1
*/
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NotPredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class NotPredicate<T> imple
/**
* Factory to create the not predicate.
*
+ * @param <T> the type that the predicate queries
* @param predicate the predicate to decorate, not null
* @return the predicate
* @throws IllegalArgumentException if the predicate is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsExceptionPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsExceptionPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsExceptionPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsExceptionPredicate.java
Thu Jul 26 19:53:10 2012
@@ -38,6 +38,7 @@ public final class NullIsExceptionPredic
/**
* Factory to create the null exception predicate.
*
+ * @param <T> the type that the predicate queries
* @param predicate the predicate to decorate, not null
* @return the predicate
* @throws IllegalArgumentException if the predicate is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsFalsePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsFalsePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsFalsePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsFalsePredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class NullIsFalsePredicate<
/**
* Factory to create the null false predicate.
*
+ * @param <T> the type that the predicate queries
* @param predicate the predicate to decorate, not null
* @return the predicate
* @throws IllegalArgumentException if the predicate is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsTruePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsTruePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsTruePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullIsTruePredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class NullIsTruePredicate<T
/**
* Factory to create the null true predicate.
*
+ * @param <T> the type that the predicate queries
* @param predicate the predicate to decorate, not null
* @return the predicate
* @throws IllegalArgumentException if the predicate is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/NullPredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class NullPredicate<T> impl
/**
* Factory returning the singleton instance.
*
+ * @param <T> the type that the predicate queries
* @return the singleton instance
* @since 3.1
*/
@@ -58,7 +59,7 @@ public final class NullPredicate<T> impl
* @param object the input object
* @return true if input is null
*/
- public boolean evaluate(Object object) {
+ public boolean evaluate(T object) {
return (object == null);
}
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OnePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OnePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OnePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OnePredicate.java
Thu Jul 26 19:53:10 2012
@@ -46,6 +46,7 @@ public final class OnePredicate<T> imple
* If the array is size zero, the predicate always returns false.
* If the array is size one, then that predicate is returned.
*
+ * @param <T> the type that the predicate queries
* @param predicates the predicates to check, cloned, not null
* @return the <code>any</code> predicate
* @throws IllegalArgumentException if the predicates array is null
@@ -66,6 +67,7 @@ public final class OnePredicate<T> imple
/**
* Factory to create the predicate.
*
+ * @param <T> the type that the predicate queries
* @param predicates the predicates to check, cloned, not null
* @return the <code>one</code> predicate
* @throws IllegalArgumentException if the predicates array is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OrPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OrPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OrPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/OrPredicate.java
Thu Jul 26 19:53:10 2012
@@ -39,6 +39,7 @@ public final class OrPredicate<T> implem
/**
* Factory to create the predicate.
*
+ * @param <T> the type that the predicate queries
* @param predicate1 the first predicate to check, not null
* @param predicate2 the second predicate to check, not null
* @return the <code>and</code> predicate
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformedPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformedPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformedPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformedPredicate.java
Thu Jul 26 19:53:10 2012
@@ -42,12 +42,14 @@ public final class TransformedPredicate<
/**
* Factory to create the predicate.
*
+ * @param <T> the type that the predicate queries
* @param transformer the transformer to call
* @param predicate the predicate to call with the result of the transform
* @return the predicate
* @throws IllegalArgumentException if the transformer or the predicate is
null
*/
- public static <T> Predicate<T> transformedPredicate(Transformer<? super T,
? extends T> transformer, Predicate<? super T> predicate) {
+ public static <T> Predicate<T> transformedPredicate(Transformer<? super T,
? extends T> transformer,
+ Predicate<? super T>
predicate) {
if (transformer == null) {
throw new IllegalArgumentException("The transformer to call must
not be null");
}
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformerPredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformerPredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformerPredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TransformerPredicate.java
Thu Jul 26 19:53:10 2012
@@ -39,6 +39,7 @@ public final class TransformerPredicate<
/**
* Factory to create the predicate.
*
+ * @param <T> the type that the predicate queries
* @param transformer the transformer to decorate
* @return the predicate
* @throws IllegalArgumentException if the transformer is null
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TruePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TruePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TruePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/TruePredicate.java
Thu Jul 26 19:53:10 2012
@@ -37,6 +37,7 @@ public final class TruePredicate<T> impl
/**
* Factory returning the singleton instance.
*
+ * @param <T> the type that the predicate queries
* @return the singleton instance
* @since 3.1
*/
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/UniquePredicate.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/UniquePredicate.java?rev=1366175&r1=1366174&r2=1366175&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/UniquePredicate.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/UniquePredicate.java
Thu Jul 26 19:53:10 2012
@@ -40,11 +40,12 @@ public final class UniquePredicate<T> im
/**
* Factory to create the predicate.
*
+ * @param <T> the type that the predicate queries
* @return the predicate
* @throws IllegalArgumentException if the predicate is null
*/
- public static <E> Predicate<E> uniquePredicate() {
- return new UniquePredicate<E>();
+ public static <T> Predicate<T> uniquePredicate() {
+ return new UniquePredicate<T>();
}
/**
