diff --git a/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java b/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java index 3cbee63ce..d0c963bfc 100644 --- a/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java @@ -30,10 +30,10 @@ public abstract class AbstractQuantifierPredicate implements Predicate, Pr /** Serial version UID */ private static final long serialVersionUID = -3094696765038308799L; - + /** The array of predicates to call */ protected final Predicate[] iPredicates; - + /** * Constructor that performs no validation. * @@ -45,7 +45,7 @@ public abstract class AbstractQuantifierPredicate implements Predicate, Pr /** * Gets the predicates. - * + * * @return a copy of the predicates * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/AllPredicate.java b/src/main/java/org/apache/commons/collections4/functors/AllPredicate.java index 211b16336..e375ca920 100644 --- a/src/main/java/org/apache/commons/collections4/functors/AllPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/AllPredicate.java @@ -40,7 +40,7 @@ public final class AllPredicate extends AbstractQuantifierPredicate implem /** Serial version UID */ private static final long serialVersionUID = -3094696765038308799L; - + /** * Factory to create the predicate. *

@@ -100,7 +100,7 @@ public final class AllPredicate extends AbstractQuantifierPredicate implem /** * Evaluates the predicate returning true if all predicates return true. - * + * * @param object the input object * @return true if all decorated predicates return true */ diff --git a/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java b/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java index 8b10b3a02..05190e30a 100644 --- a/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java @@ -22,17 +22,17 @@ import org.apache.commons.collections4.FunctorException; /** * {@link Closure} that catches any checked exception and re-throws it as a * {@link FunctorException} runtime exception. Example usage: - * + * * 

  * // Create a catch and re-throw closure via anonymous subclass
  * CatchAndRethrowClosure<String> writer = new ThrowingClosure() {
  *     private java.io.Writer out = // some writer
- *     
+ *
  *     protected void executeAndThrow(String input) throws IOException {
  *         out.write(input); // throwing of IOException allowed
  *     }
  * };
- * 
+ *
  * // use catch and re-throw closure
  * java.util.List strList = // some list
  * try {
@@ -42,7 +42,7 @@ import org.apache.commons.collections4.FunctorException;
  *     // handle error
  * }
  *
- * + * * @since 4.0 * @version $Id$ */ @@ -50,7 +50,7 @@ public abstract class CatchAndRethrowClosure implements Closure { /** * Execute this closure on the specified input object. - * + * * @param input the input to execute on * @throws FunctorException (runtime) if the closure execution resulted in a * checked exception. @@ -67,7 +67,7 @@ public abstract class CatchAndRethrowClosure implements Closure { /** * Execute this closure on the specified input object. - * + * * @param input the input to execute on * @throws Throwable if the closure execution resulted in a checked * exception. diff --git a/src/main/java/org/apache/commons/collections4/functors/ChainedClosure.java b/src/main/java/org/apache/commons/collections4/functors/ChainedClosure.java index b905c0c6c..ca415d63b 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ChainedClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/ChainedClosure.java @@ -37,7 +37,7 @@ public class ChainedClosure implements Closure, Serializable { /** * Factory method that performs validation and copies the parameter array. - * + * * @param the type that the closure acts on * @param closures the closures to chain, copied, no nulls * @return the chained closure @@ -53,10 +53,10 @@ public class ChainedClosure implements Closure, Serializable { } /** - * Create a new Closure that calls each closure in turn, passing the + * Create a new Closure that calls each closure in turn, passing the * result into the next closure. The ordering is that of the iterator() * method on the collection. - * + * * @param the type that the closure acts on * @param closures a collection of closures to chain * @return the chained closure @@ -84,7 +84,7 @@ public class ChainedClosure implements Closure, Serializable { /** * Constructor that performs no validation. * Use chainedClosure if you want that. - * + * * @param closures the closures to chain, not copied, no nulls */ public ChainedClosure(final Closure[] closures) { @@ -94,7 +94,7 @@ public class ChainedClosure implements Closure, Serializable { /** * Execute a list of closures. - * + * * @param input the input object passed to each closure */ public void execute(final E input) { diff --git a/src/main/java/org/apache/commons/collections4/functors/ChainedTransformer.java b/src/main/java/org/apache/commons/collections4/functors/ChainedTransformer.java index d6f6270b9..5f270538c 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ChainedTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/ChainedTransformer.java @@ -54,9 +54,9 @@ public class ChainedTransformer implements Transformer, Serializable { } return new ChainedTransformer(FunctorUtils.copy(transformers)); } - + /** - * Create a new Transformer that calls each transformer in turn, passing the + * Create a new Transformer that calls each transformer in turn, passing the * result into the next transformer. The ordering is that of the iterator() * method on the collection. * @@ -83,7 +83,7 @@ public class ChainedTransformer implements Transformer, Serializable { /** * Constructor that performs no validation. * Use chainedTransformer if you want that. - * + * * @param transformers the transformers to chain, not copied, no nulls */ public ChainedTransformer(final Transformer[] transformers) { @@ -93,7 +93,7 @@ public class ChainedTransformer implements Transformer, Serializable { /** * Transforms the input to result via each decorated transformer - * + * * @param object the input object passed to the first transformer * @return the transformed result */ diff --git a/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java b/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java index d065eacaa..33dd7ecf1 100644 --- a/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java @@ -57,7 +57,7 @@ public class CloneTransformer implements Transformer, Serializable { /** * Transforms the input to result by cloning it. - * + * * @param input the input object to transform * @return the transformed result */ diff --git a/src/main/java/org/apache/commons/collections4/functors/ClosureTransformer.java b/src/main/java/org/apache/commons/collections4/functors/ClosureTransformer.java index f0db919e0..fbf2c913e 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ClosureTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/ClosureTransformer.java @@ -54,7 +54,7 @@ public class ClosureTransformer implements Transformer, Serializable { /** * Constructor that performs no validation. * Use closureTransformer if you want that. - * + * * @param closure the closure to call, not null */ public ClosureTransformer(final Closure closure) { @@ -64,7 +64,7 @@ public class ClosureTransformer implements Transformer, Serializable { /** * Transforms the input to result by executing a closure. - * + * * @param input the input object to transform * @return the transformed result */ @@ -75,7 +75,7 @@ public class ClosureTransformer implements Transformer, Serializable { /** * Gets the closure. - * + * * @return the closure * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java index 4834167fb..dd43b66bb 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java @@ -157,7 +157,7 @@ public class ComparatorPredicate implements Predicate, Serializable { * * @see org.apache.commons.collections4.Predicate#evaluate(java.lang.Object) * @see java.util.Comparator#compare(java.lang.Object first, java.lang.Object second) - * + * * @param target the target object to compare to * @return {@code true} if the comparison succeeds according to the selected criterion * @throws IllegalStateException if the criterion is invalid (really not possible) diff --git a/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java b/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java index 8efdd7fb4..0950f6681 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java @@ -34,7 +34,7 @@ public class ConstantFactory implements Factory, Serializable { /** Serial version UID */ private static final long serialVersionUID = -3520677225766901240L; - + /** Returns null each time */ public static final Factory NULL_INSTANCE = new ConstantFactory(null); @@ -55,11 +55,11 @@ public class ConstantFactory implements Factory, Serializable { } return new ConstantFactory(constantToReturn); } - + /** * Constructor that performs no validation. * Use constantFactory if you want that. - * + * * @param constantToReturn the constant to return each time */ public ConstantFactory(final T constantToReturn) { @@ -69,7 +69,7 @@ public class ConstantFactory implements Factory, Serializable { /** * Always return constant. - * + * * @return the stored constant value */ public T create() { @@ -78,7 +78,7 @@ public class ConstantFactory implements Factory, Serializable { /** * Gets the constant. - * + * * @return the constant * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java b/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java index c8b229a67..4bd0091ee 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java @@ -34,7 +34,7 @@ public class ConstantTransformer implements Transformer, Serializabl /** Serial version UID */ private static final long serialVersionUID = 6374440726369055124L; - + /** Returns null each time */ public static final Transformer NULL_INSTANCE = new ConstantTransformer(null); @@ -67,11 +67,11 @@ public class ConstantTransformer implements Transformer, Serializabl } return new ConstantTransformer(constantToReturn); } - + /** * Constructor that performs no validation. * Use constantTransformer if you want that. - * + * * @param constantToReturn the constant to return each time */ public ConstantTransformer(final O constantToReturn) { @@ -81,7 +81,7 @@ public class ConstantTransformer implements Transformer, Serializabl /** * Transforms the input by ignoring it and returning the stored constant instead. - * + * * @param input the input object which is ignored * @return the stored constant */ @@ -91,7 +91,7 @@ public class ConstantTransformer implements Transformer, Serializabl /** * Gets the constant. - * + * * @return the constant * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/DefaultEquator.java b/src/main/java/org/apache/commons/collections4/functors/DefaultEquator.java index 78de84ffc..d4f700395 100644 --- a/src/main/java/org/apache/commons/collections4/functors/DefaultEquator.java +++ b/src/main/java/org/apache/commons/collections4/functors/DefaultEquator.java @@ -20,7 +20,7 @@ import java.io.Serializable; /** * Default {@link Equator} implementation. - * + * * @param the types of object this {@link Equator} can evaluate. * @since 4.0 * @version $Id$ @@ -40,7 +40,7 @@ public class DefaultEquator implements Equator, Serializable { /** * Factory returning the typed singleton instance. - * + * * @param the object type * @return the singleton instance */ @@ -65,7 +65,7 @@ public class DefaultEquator implements Equator, Serializable { /** * {@inheritDoc} - * + * * @return o.hashCode() if o is non- * null, else {@link #HASHCODE_NULL}. */ diff --git a/src/main/java/org/apache/commons/collections4/functors/EqualPredicate.java b/src/main/java/org/apache/commons/collections4/functors/EqualPredicate.java index e2b957680..7a8923764 100644 --- a/src/main/java/org/apache/commons/collections4/functors/EqualPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/EqualPredicate.java @@ -36,13 +36,13 @@ public final class EqualPredicate implements Predicate, Serializable { /** The value to compare to */ private final T iValue; - + /** The equator to use for comparison */ private final Equator equator; /** * Factory to create the predicate. - * + * * @param the type that the predicate queries * @param object the object to compare to * @return the predicate @@ -57,7 +57,7 @@ public final class EqualPredicate implements Predicate, Serializable { /** * Factory to create the identity predicate. - * + * * @param the type that the predicate queries * @param object the object to compare to * @param equator the equator to use for comparison @@ -75,7 +75,7 @@ public final class EqualPredicate implements Predicate, Serializable { /** * Constructor that performs no validation. * Use equalPredicate if you want that. - * + * * @param object the object to compare to */ public EqualPredicate(final T object) { @@ -87,7 +87,7 @@ public final class EqualPredicate implements Predicate, Serializable { /** * Constructor that performs no validation. * Use equalPredicate if you want that. - * + * * @param object the object to compare to * @param equator the equator to use for comparison * @since 4.0 @@ -100,7 +100,7 @@ public final class EqualPredicate implements Predicate, Serializable { /** * Evaluates the predicate returning true if the input equals the stored value. - * + * * @param object the input object * @return true if input object equals stored value */ @@ -114,7 +114,7 @@ public final class EqualPredicate implements Predicate, Serializable { /** * Gets the value. - * + * * @return the value * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/Equator.java b/src/main/java/org/apache/commons/collections4/functors/Equator.java index 4a721b7ed..739b202ad 100644 --- a/src/main/java/org/apache/commons/collections4/functors/Equator.java +++ b/src/main/java/org/apache/commons/collections4/functors/Equator.java @@ -11,14 +11,11 @@ package org.apache.commons.collections4.functors; /** - *

* An equation function, which determines equality between objects of type T. - *

*

* It is the functional sibling of {@link java.util.Comparator}; {@link Equator} is to * {@link Object} as {@link java.util.Comparator} is to {@link java.lang.Comparable}. - *

- * + * * @param the types of object this {@link Equator} can evaluate. * @since 4.0 * @version $Id$ @@ -26,7 +23,7 @@ package org.apache.commons.collections4.functors; public interface Equator { /** * Evaluates the two arguments for their equality. - * + * * @param o1 the first object to be equated. * @param o2 the second object to be equated. * @return whether the two objects are equal. @@ -38,7 +35,7 @@ public interface Equator { * method. This is used for classes that delegate their {@link Object#equals(Object) equals(Object)} method to an * Equator (and so must also delegate their {@link Object#hashCode() hashCode()} method), or for implementations * of {@link org.apache.commons.collections4.map.HashedMap} that use an Equator for the key objects. - * + * * @param o the object to calculate the hash for. * @return the hash of the object. */ diff --git a/src/main/java/org/apache/commons/collections4/functors/ExceptionClosure.java b/src/main/java/org/apache/commons/collections4/functors/ExceptionClosure.java index 5703dcc33..2ec6d59dd 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ExceptionClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/ExceptionClosure.java @@ -37,7 +37,7 @@ public final class ExceptionClosure implements Closure, Serializable { /** * Factory returning the singleton instance. - * + * * @param the type that the closure acts on * @return the singleton instance * @since 3.1 @@ -56,7 +56,7 @@ public final class ExceptionClosure implements Closure, Serializable { /** * Always throw an exception. - * + * * @param input the input object * @throws FunctorException always */ diff --git a/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java b/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java index 6071158de..47c5ebf1a 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java @@ -37,7 +37,7 @@ public final class ExceptionFactory implements Factory, Serializable { /** * Factory returning the singleton instance. - * + * * @param the type the factory creates * @return the singleton instance * @since 3.1 @@ -56,7 +56,7 @@ public final class ExceptionFactory implements Factory, Serializable { /** * Always throws an exception. - * + * * @return never * @throws FunctorException always */ diff --git a/src/main/java/org/apache/commons/collections4/functors/FactoryTransformer.java b/src/main/java/org/apache/commons/collections4/functors/FactoryTransformer.java index 7fafbbc09..96613b8a0 100644 --- a/src/main/java/org/apache/commons/collections4/functors/FactoryTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/FactoryTransformer.java @@ -37,7 +37,7 @@ public class FactoryTransformer implements Transformer, Serializable /** * Factory method that performs validation. - * + * * @param the input type * @param the output type * @param factory the factory to call, not null @@ -54,7 +54,7 @@ public class FactoryTransformer implements Transformer, Serializable /** * Constructor that performs no validation. * Use factoryTransformer if you want that. - * + * * @param factory the factory to call, not null */ public FactoryTransformer(final Factory factory) { @@ -65,7 +65,7 @@ public class FactoryTransformer implements Transformer, Serializable /** * Transforms the input by ignoring the input and returning the result of * calling the decorated factory. - * + * * @param input the input object to transform * @return the transformed result */ @@ -75,7 +75,7 @@ public class FactoryTransformer implements Transformer, Serializable /** * Gets the factory. - * + * * @return the factory * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/ForClosure.java b/src/main/java/org/apache/commons/collections4/functors/ForClosure.java index 06af351cd..da2ecf0e3 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ForClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/ForClosure.java @@ -41,7 +41,7 @@ public class ForClosure implements Closure, Serializable { *

* A null closure or zero count returns the NOPClosure. * A count of one returns the specified closure. - * + * * @param the type that the closure acts on * @param count the number of times to execute the closure * @param closure the closure to execute, not null @@ -61,7 +61,7 @@ public class ForClosure implements Closure, Serializable { /** * Constructor that performs no validation. * Use forClosure if you want that. - * + * * @param count the number of times to execute the closure * @param closure the closure to execute, not null */ @@ -73,7 +73,7 @@ public class ForClosure implements Closure, Serializable { /** * Executes the closure count times. - * + * * @param input the input object */ public void execute(final E input) { @@ -84,7 +84,7 @@ public class ForClosure implements Closure, Serializable { /** * Gets the closure. - * + * * @return the closure * @since 3.1 */ @@ -94,7 +94,7 @@ public class ForClosure implements Closure, Serializable { /** * Gets the count. - * + * * @return the count * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/IfClosure.java b/src/main/java/org/apache/commons/collections4/functors/IfClosure.java index 07190adaf..4d9aafee4 100644 --- a/src/main/java/org/apache/commons/collections4/functors/IfClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/IfClosure.java @@ -45,7 +45,7 @@ public class IfClosure implements Closure, Serializable { *

* This factory creates a closure that performs no action when * the predicate is false. - * + * * @param the type that the closure acts on * @param predicate predicate to switch on * @param trueClosure closure used if true @@ -59,7 +59,7 @@ public class IfClosure implements Closure, Serializable { /** * Factory method that performs validation. - * + * * @param the type that the closure acts on * @param predicate predicate to switch on * @param trueClosure closure used if true @@ -85,7 +85,7 @@ public class IfClosure implements Closure, Serializable { *

* This constructor creates a closure that performs no action when * the predicate is false. - * + * * @param predicate predicate to switch on, not null * @param trueClosure closure used if true, not null * @since 3.2 @@ -97,7 +97,7 @@ public class IfClosure implements Closure, Serializable { /** * Constructor that performs no validation. * Use ifClosure if you want that. - * + * * @param predicate predicate to switch on, not null * @param trueClosure closure used if true, not null * @param falseClosure closure used if false, not null @@ -112,7 +112,7 @@ public class IfClosure implements Closure, Serializable { /** * Executes the true or false closure according to the result of the predicate. - * + * * @param input the input object */ public void execute(final E input) { @@ -125,7 +125,7 @@ public class IfClosure implements Closure, Serializable { /** * Gets the predicate. - * + * * @return the predicate * @since 3.1 */ @@ -135,7 +135,7 @@ public class IfClosure implements Closure, Serializable { /** * Gets the closure called when true. - * + * * @return the closure * @since 3.1 */ @@ -145,7 +145,7 @@ public class IfClosure implements Closure, Serializable { /** * Gets the closure called when false. - * + * * @return the closure * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java index deecb3589..8a313f9df 100644 --- a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java @@ -45,7 +45,7 @@ public class InstantiateFactory implements Factory, Serializable { /** * Factory method that performs validation. - * + * * @param the type the factory creates * @param classToInstantiate the class to instantiate, not null * @param paramTypes the constructor parameter types, cloned @@ -73,7 +73,7 @@ public class InstantiateFactory implements Factory, Serializable { /** * Constructor that performs no validation. * Use instantiateFactory if you want that. - * + * * @param classToInstantiate the class to instantiate */ public InstantiateFactory(final Class classToInstantiate) { @@ -87,7 +87,7 @@ public class InstantiateFactory implements Factory, Serializable { /** * Constructor that performs no validation. * Use instantiateFactory if you want that. - * + * * @param classToInstantiate the class to instantiate * @param paramTypes the constructor parameter types, cloned * @param args the constructor arguments, cloned @@ -113,7 +113,7 @@ public class InstantiateFactory implements Factory, Serializable { /** * Creates an object using the stored constructor. - * + * * @return the new object */ public T create() { @@ -132,5 +132,5 @@ public class InstantiateFactory implements Factory, Serializable { throw new FunctorException("InstantiateFactory: Constructor threw an exception", ex); } } - + } diff --git a/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java b/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java index ec233bb4b..49686d9ca 100644 --- a/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java @@ -33,7 +33,7 @@ public class InvokerTransformer implements Transformer, Serializable /** The serial version */ private static final long serialVersionUID = -8653385846894047688L; - + /** The method name to call */ private final String iMethodName; /** The array of reflection parameter types */ @@ -43,7 +43,7 @@ public class InvokerTransformer implements Transformer, Serializable /** * Gets an instance of this transformer calling a specific method with no arguments. - * + * * @param the input type * @param the output type * @param methodName the method name to call @@ -88,7 +88,7 @@ public class InvokerTransformer implements Transformer, Serializable /** * Constructor for no arg instance. - * + * * @param methodName the method to call */ private InvokerTransformer(final String methodName) { @@ -101,7 +101,7 @@ public class InvokerTransformer implements Transformer, Serializable /** * Constructor that performs no validation. * Use invokerTransformer if you want that. - * + * * @param methodName the method to call * @param paramTypes the constructor parameter types, not cloned * @param args the constructor arguments, not cloned @@ -115,7 +115,7 @@ public class InvokerTransformer implements Transformer, Serializable /** * Transforms the input to result by invoking a method on the input. - * + * * @param input the input object to transform * @return the transformed result, null if null input */ diff --git a/src/main/java/org/apache/commons/collections4/functors/NotPredicate.java b/src/main/java/org/apache/commons/collections4/functors/NotPredicate.java index 1f56face1..0600bfc11 100644 --- a/src/main/java/org/apache/commons/collections4/functors/NotPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/NotPredicate.java @@ -30,13 +30,13 @@ public final class NotPredicate implements Predicate, PredicateDecorator iPredicate; - + /** * Factory to create the not predicate. - * + * * @param the type that the predicate queries * @param predicate the predicate to decorate, not null * @return the predicate @@ -52,7 +52,7 @@ public final class NotPredicate implements Predicate, PredicateDecoratornotPredicate if you want that. - * + * * @param predicate the predicate to call after the null check */ public NotPredicate(final Predicate predicate) { @@ -62,7 +62,7 @@ public final class NotPredicate implements Predicate, PredicateDecorator implements Predicate, PredicateDecorator implements Predicate, Predicat /** Serial version UID */ private static final long serialVersionUID = 3243449850504576071L; - + /** The predicate to decorate */ private final Predicate iPredicate; - + /** * Factory to create the null exception predicate. - * + * * @param the type that the predicate queries * @param predicate the predicate to decorate, not null * @return the predicate @@ -53,7 +53,7 @@ public final class NullIsExceptionPredicate implements Predicate, Predicat /** * Constructor that performs no validation. * Use nullIsExceptionPredicate if you want that. - * + * * @param predicate the predicate to call after the null check */ public NullIsExceptionPredicate(final Predicate predicate) { @@ -64,7 +64,7 @@ public final class NullIsExceptionPredicate implements Predicate, Predicat /** * Evaluates the predicate returning the result of the decorated predicate * once a null check is performed. - * + * * @param object the input object * @return true if decorated predicate returns true * @throws FunctorException if input is null @@ -78,7 +78,7 @@ public final class NullIsExceptionPredicate implements Predicate, Predicat /** * Gets the predicate being decorated. - * + * * @return the predicate as the only element in an array * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/NullIsTruePredicate.java b/src/main/java/org/apache/commons/collections4/functors/NullIsTruePredicate.java index 7bc57f5ea..8eda7922c 100644 --- a/src/main/java/org/apache/commons/collections4/functors/NullIsTruePredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/NullIsTruePredicate.java @@ -30,13 +30,13 @@ public final class NullIsTruePredicate implements Predicate, PredicateDeco /** Serial version UID */ private static final long serialVersionUID = -7625133768987126273L; - + /** The predicate to decorate */ private final Predicate iPredicate; - + /** * Factory to create the null true predicate. - * + * * @param the type that the predicate queries * @param predicate the predicate to decorate, not null * @return the predicate @@ -52,7 +52,7 @@ public final class NullIsTruePredicate implements Predicate, PredicateDeco /** * Constructor that performs no validation. * Use nullIsTruePredicate if you want that. - * + * * @param predicate the predicate to call after the null check */ public NullIsTruePredicate(final Predicate predicate) { @@ -63,7 +63,7 @@ public final class NullIsTruePredicate implements Predicate, PredicateDeco /** * Evaluates the predicate returning the result of the decorated predicate * once a null check is performed. - * + * * @param object the input object * @return true if decorated predicate returns true or input is null */ @@ -76,7 +76,7 @@ public final class NullIsTruePredicate implements Predicate, PredicateDeco /** * Gets the predicate being decorated. - * + * * @return the predicate as the only element in an array * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/OnePredicate.java b/src/main/java/org/apache/commons/collections4/functors/OnePredicate.java index 30ecbdf93..12716dfcf 100644 --- a/src/main/java/org/apache/commons/collections4/functors/OnePredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/OnePredicate.java @@ -36,7 +36,7 @@ public final class OnePredicate extends AbstractQuantifierPredicate implem /** Serial version UID */ private static final long serialVersionUID = -8125389089924745785L; - + /** * Factory to create the predicate. *

@@ -78,7 +78,7 @@ public final class OnePredicate extends AbstractQuantifierPredicate implem /** * Constructor that performs no validation. * Use onePredicate if you want that. - * + * * @param predicates the predicates to check, not cloned, not null */ public OnePredicate(final Predicate[] predicates) { @@ -88,7 +88,7 @@ public final class OnePredicate extends AbstractQuantifierPredicate implem /** * Evaluates the predicate returning true if only one decorated predicate * returns true. - * + * * @param object the input object * @return true if only one decorated predicate returns true */ diff --git a/src/main/java/org/apache/commons/collections4/functors/PredicateDecorator.java b/src/main/java/org/apache/commons/collections4/functors/PredicateDecorator.java index 8f6d06772..ed0397365 100644 --- a/src/main/java/org/apache/commons/collections4/functors/PredicateDecorator.java +++ b/src/main/java/org/apache/commons/collections4/functors/PredicateDecorator.java @@ -33,7 +33,7 @@ public interface PredicateDecorator extends Predicate { *

* The array may be the internal data structure of the predicate and thus * should not be altered. - * + * * @return the predicates being decorated */ Predicate[] getPredicates(); diff --git a/src/main/java/org/apache/commons/collections4/functors/PredicateTransformer.java b/src/main/java/org/apache/commons/collections4/functors/PredicateTransformer.java index e0f588dc7..61c632565 100644 --- a/src/main/java/org/apache/commons/collections4/functors/PredicateTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/PredicateTransformer.java @@ -38,7 +38,7 @@ public class PredicateTransformer implements Transformer, Seriali /** * Factory method that performs validation. - * + * * @param the input type * @param predicate the predicate to call, not null * @return the predicate transformer @@ -54,7 +54,7 @@ public class PredicateTransformer implements Transformer, Seriali /** * Constructor that performs no validation. * Use predicateTransformer if you want that. - * + * * @param predicate the predicate to call, not null */ public PredicateTransformer(final Predicate predicate) { @@ -64,7 +64,7 @@ public class PredicateTransformer implements Transformer, Seriali /** * Transforms the input to result by calling a predicate. - * + * * @param input the input object to transform * @return the transformed result */ @@ -74,7 +74,7 @@ public class PredicateTransformer implements Transformer, Seriali /** * Gets the predicate. - * + * * @return the predicate * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java index acefafcc2..9d808c4ef 100644 --- a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java @@ -92,10 +92,10 @@ public class PrototypeFactory { * PrototypeCloneFactory creates objects by copying a prototype using the clone method. */ static class PrototypeCloneFactory implements Factory, Serializable { - + /** The serial version */ private static final long serialVersionUID = 5604271422565175555L; - + /** The object to clone each time */ private final T iPrototype; /** The method used to clone */ @@ -123,7 +123,7 @@ public class PrototypeFactory { /** * Creates an object by calling the clone method. - * + * * @return the new object */ @SuppressWarnings("unchecked") @@ -149,10 +149,10 @@ public class PrototypeFactory { * PrototypeSerializationFactory creates objects by cloning a prototype using serialization. */ static class PrototypeSerializationFactory implements Factory, Serializable { - + /** The serial version */ private static final long serialVersionUID = -8704966966139178833L; - + /** The object to clone via serialization each time */ private final T iPrototype; @@ -166,7 +166,7 @@ public class PrototypeFactory { /** * Creates an object using serialization. - * + * * @return the new object */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java b/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java index 2381fabc0..ca6f6af57 100644 --- a/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java @@ -43,7 +43,7 @@ public class SwitchTransformer implements Transformer, Serializable /** * Factory method that performs validation and copies the parameter arrays. - * + * * @param the input type * @param the output type * @param predicates array of predicates, cloned, no nulls @@ -72,16 +72,16 @@ public class SwitchTransformer implements Transformer, Serializable } /** - * Create a new Transformer that calls one of the transformers depending - * on the predicates. + * Create a new Transformer that calls one of the transformers depending + * on the predicates. *

- * The Map consists of Predicate keys and Transformer values. A transformer + * The Map consists of Predicate keys and Transformer values. A transformer * is called if its matching predicate returns true. Each predicate is evaluated * until one returns true. If no predicates evaluate to true, the default - * transformer is called. The default transformer is set in the map with a - * null key. The ordering is that of the iterator() method on the entryset + * transformer is called. The default transformer is set in the map with a + * null key. The ordering is that of the iterator() method on the entryset * collection of the map. - * + * * @param the input type * @param the output type * @param map a map of predicates to transformers @@ -118,11 +118,11 @@ public class SwitchTransformer implements Transformer, Serializable } return new SwitchTransformer(preds, transformers, defaultTransformer); } - + /** * Constructor that performs no validation. * Use switchTransformer if you want that. - * + * * @param predicates array of predicates, not cloned, no nulls * @param transformers matching array of transformers, not cloned, no nulls * @param defaultTransformer the transformer to use if no match, null means return null @@ -141,7 +141,7 @@ public class SwitchTransformer implements Transformer, Serializable /** * Transforms the input to result by calling the transformer whose matching * predicate returns true. - * + * * @param input the input object to transform * @return the transformed result */ @@ -156,7 +156,7 @@ public class SwitchTransformer implements Transformer, Serializable /** * Gets the predicates. - * + * * @return a copy of the predicates * @since 3.1 */ @@ -166,7 +166,7 @@ public class SwitchTransformer implements Transformer, Serializable /** * Gets the transformers. - * + * * @return a copy of the transformers * @since 3.1 */ @@ -176,7 +176,7 @@ public class SwitchTransformer implements Transformer, Serializable /** * Gets the default transformer. - * + * * @return the default transformer * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/TransformerClosure.java b/src/main/java/org/apache/commons/collections4/functors/TransformerClosure.java index 2dc0abad5..f3430ec6f 100644 --- a/src/main/java/org/apache/commons/collections4/functors/TransformerClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/TransformerClosure.java @@ -40,7 +40,7 @@ public class TransformerClosure implements Closure, Serializable { * Factory method that performs validation. *

* A null transformer will return the NOPClosure. - * + * * @param the type that the closure acts on * @param transformer the transformer to call, null means nop * @return the transformer closure @@ -55,7 +55,7 @@ public class TransformerClosure implements Closure, Serializable { /** * Constructor that performs no validation. * Use transformerClosure if you want that. - * + * * @param transformer the transformer to call, not null */ public TransformerClosure(final Transformer transformer) { @@ -65,7 +65,7 @@ public class TransformerClosure implements Closure, Serializable { /** * Executes the closure by calling the decorated transformer. - * + * * @param input the input object */ public void execute(final E input) { @@ -74,7 +74,7 @@ public class TransformerClosure implements Closure, Serializable { /** * Gets the transformer. - * + * * @return the transformer * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java b/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java index 90bb73353..46e62019d 100644 --- a/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java @@ -42,7 +42,7 @@ public class WhileClosure implements Closure, Serializable { /** * Factory method that performs validation. - * + * * @param the type that the closure acts on * @param predicate the predicate used to evaluate when the loop terminates, not null * @param closure the closure the execute, not null @@ -64,7 +64,7 @@ public class WhileClosure implements Closure, Serializable { /** * Constructor that performs no validation. * Use whileClosure if you want that. - * + * * @param predicate the predicate used to evaluate when the loop terminates, not null * @param closure the closure the execute, not null * @param doLoop true to act as a do-while loop, always executing the closure once @@ -78,7 +78,7 @@ public class WhileClosure implements Closure, Serializable { /** * Executes the closure until the predicate is false. - * + * * @param input the input object */ public void execute(final E input) { @@ -92,7 +92,7 @@ public class WhileClosure implements Closure, Serializable { /** * Gets the predicate in use. - * + * * @return the predicate * @since 3.1 */ @@ -102,7 +102,7 @@ public class WhileClosure implements Closure, Serializable { /** * Gets the closure. - * + * * @return the closure * @since 3.1 */ @@ -112,7 +112,7 @@ public class WhileClosure implements Closure, Serializable { /** * Is the loop a do-while loop. - * + * * @return true is do-while, false if while * @since 3.1 */ diff --git a/src/main/java/org/apache/commons/collections4/functors/package-info.java b/src/main/java/org/apache/commons/collections4/functors/package-info.java index 321edd43f..198fc541c 100644 --- a/src/main/java/org/apache/commons/collections4/functors/package-info.java +++ b/src/main/java/org/apache/commons/collections4/functors/package-info.java @@ -21,7 +21,7 @@ * {@link org.apache.commons.collections4.Transformer Transformer} and * {@link org.apache.commons.collections4.Factory Factory} interfaces. * These provide simple callbacks for processing with collections. - * + * * @version $Id$ */ package org.apache.commons.collections4.functors;