Replace references to getInstance with the corresponding factory method name.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1476582 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2013-04-27 14:13:54 +00:00
parent fad4f969df
commit cca574ea06
39 changed files with 44 additions and 46 deletions

View File

@ -36,7 +36,6 @@ public abstract class AbstractQuantifierPredicate<T> implements Predicate<T>, Pr
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that.
* *
* @param predicates the predicates to check, not cloned, not null * @param predicates the predicates to check, not cloned, not null
*/ */

View File

@ -90,7 +90,7 @@ public final class AllPredicate<T> extends AbstractQuantifierPredicate<T> implem
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>allPredicate</code> if you want that.
* *
* @param predicates the predicates to check, not cloned, not null * @param predicates the predicates to check, not cloned, not null
*/ */

View File

@ -55,7 +55,7 @@ public final class AndPredicate<T> implements Predicate<T>, PredicateDecorator<T
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>andPredicate</code> if you want that.
* *
* @param predicate1 the first predicate to check, not null * @param predicate1 the first predicate to check, not null
* @param predicate2 the second predicate to check, not null * @param predicate2 the second predicate to check, not null

View File

@ -87,7 +87,7 @@ public final class AnyPredicate<T> extends AbstractQuantifierPredicate<T> implem
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>anyPredicate</code> if you want that.
* *
* @param predicates the predicates to check, not cloned, not null * @param predicates the predicates to check, not cloned, not null
*/ */

View File

@ -83,7 +83,7 @@ public class ChainedClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>chainedClosure</code> if you want that.
* *
* @param closures the closures to chain, not copied, no nulls * @param closures the closures to chain, not copied, no nulls
*/ */

View File

@ -82,7 +82,7 @@ public class ChainedTransformer<T> implements Transformer<T, T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>chainedTransformer</code> if you want that.
* *
* @param transformers the transformers to chain, not copied, no nulls * @param transformers the transformers to chain, not copied, no nulls
*/ */

View File

@ -23,7 +23,7 @@ import org.apache.commons.collections4.Transformer;
/** /**
* Transformer implementation that returns a clone of the input object. * Transformer implementation that returns a clone of the input object.
* <p> * <p>
* Clone is performed using <code>PrototypeFactory.getInstance(input).create()</code>. * Clone is performed using <code>PrototypeFactory.prototypeFactory(input).create()</code>.
* *
* @since 3.0 * @since 3.0
* @version $Id$ * @version $Id$
@ -49,7 +49,7 @@ public class CloneTransformer<T> implements Transformer<T, T>, Serializable {
} }
/** /**
* Constructor * Constructor.
*/ */
private CloneTransformer() { private CloneTransformer() {
super(); super();

View File

@ -53,7 +53,7 @@ public class ClosureTransformer<T> implements Transformer<T, T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>closureTransformer</code> if you want that.
* *
* @param closure the closure to call, not null * @param closure the closure to call, not null
*/ */

View File

@ -44,7 +44,7 @@ import org.apache.commons.collections4.Predicate;
* following way: * following way:
* *
* <pre> * <pre>
* ComparatorPredicate.getInstance(ONE, comparator).evaluate(TWO); * ComparatorPredicate.comparatorPredicate(ONE, comparator).evaluate(TWO);
* </pre> * </pre>
* *
* The input variable <code>TWO</code> in compared to the stored variable <code>ONE</code> using * The input variable <code>TWO</code> in compared to the stored variable <code>ONE</code> using
@ -66,7 +66,7 @@ import org.apache.commons.collections4.Predicate;
* evaluation of a comparator result. * evaluation of a comparator result.
* *
* <pre> * <pre>
* ComparatorPredicate.getInstance(ONE, comparator, <b>ComparatorPredicate.Criterion.GREATER</b>).evaluate(TWO); * ComparatorPredicate.comparatorPredicate(ONE, comparator,<b>ComparatorPredicate.Criterion.GREATER</b>).evaluate(TWO);
* </pre> * </pre>
* *
* The input variable TWO is compared to the stored variable ONE using the supplied <code>comparator</code> * The input variable TWO is compared to the stored variable ONE using the supplied <code>comparator</code>
@ -131,7 +131,7 @@ public class ComparatorPredicate<T> implements Predicate<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want. * Use <code>comparatorPredicate</code> if you want that.
* *
* @param object the object to compare to * @param object the object to compare to
* @param comparator the comparator to use for comparison * @param comparator the comparator to use for comparison

View File

@ -58,7 +58,7 @@ public class ConstantFactory<T> implements Factory<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>constantFactory</code> if you want that.
* *
* @param constantToReturn the constant to return each time * @param constantToReturn the constant to return each time
*/ */

View File

@ -70,7 +70,7 @@ public class ConstantTransformer<I, O> implements Transformer<I, O>, Serializabl
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>constantTransformer</code> if you want that.
* *
* @param constantToReturn the constant to return each time * @param constantToReturn the constant to return each time
*/ */

View File

@ -74,7 +74,7 @@ public final class EqualPredicate<T> implements Predicate<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>equalPredicate</code> if you want that.
* *
* @param object the object to compare to * @param object the object to compare to
*/ */
@ -86,7 +86,7 @@ public final class EqualPredicate<T> implements Predicate<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>equalPredicate</code> if you want that.
* *
* @param object the object to compare to * @param object the object to compare to
* @param equator the equator to use for comparison * @param equator the equator to use for comparison

View File

@ -53,7 +53,7 @@ public class FactoryTransformer<I, O> implements Transformer<I, O>, Serializable
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>factoryTransformer</code> if you want that.
* *
* @param factory the factory to call, not null * @param factory the factory to call, not null
*/ */

View File

@ -60,7 +60,7 @@ public class ForClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>forClosure</code> if you want that.
* *
* @param count the number of times to execute the closure * @param count the number of times to execute the closure
* @param closure the closure to execute, not null * @param closure the closure to execute, not null

View File

@ -52,7 +52,7 @@ public final class IdentityPredicate<T> implements Predicate<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>identityPredicate</code> if you want that.
* *
* @param object the object to compare to * @param object the object to compare to
*/ */

View File

@ -81,7 +81,7 @@ public class IfClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>ifClosure</code> if you want that.
* <p> * <p>
* This constructor creates a closure that performs no action when * This constructor creates a closure that performs no action when
* the predicate is false. * the predicate is false.
@ -96,7 +96,7 @@ public class IfClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>ifClosure</code> if you want that.
* *
* @param predicate predicate to switch on, not null * @param predicate predicate to switch on, not null
* @param trueClosure closure used if true, not null * @param trueClosure closure used if true, not null

View File

@ -51,7 +51,7 @@ public final class InstanceofPredicate implements Predicate<Object>, Serializabl
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>instanceOfPredicate</code> if you want that.
* *
* @param type the type to check for * @param type the type to check for
*/ */

View File

@ -72,7 +72,7 @@ public class InstantiateFactory<T> implements Factory<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>instantiateFactory</code> if you want that.
* *
* @param classToInstantiate the class to instantiate * @param classToInstantiate the class to instantiate
*/ */
@ -86,7 +86,7 @@ public class InstantiateFactory<T> implements Factory<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>instantiateFactory</code> if you want that.
* *
* @param classToInstantiate the class to instantiate * @param classToInstantiate the class to instantiate
* @param paramTypes the constructor parameter types, cloned * @param paramTypes the constructor parameter types, cloned

View File

@ -86,7 +86,7 @@ public class InstantiateTransformer<T> implements Transformer<Class<? extends T>
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>instantiateTransformer</code> if you want that.
* *
* @param paramTypes the constructor parameter types, not cloned * @param paramTypes the constructor parameter types, not cloned
* @param args the constructor arguments, not cloned * @param args the constructor arguments, not cloned

View File

@ -100,7 +100,7 @@ public class InvokerTransformer<I, O> implements Transformer<I, O>, Serializable
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>invokerTransformer</code> if you want that.
* *
* @param methodName the method to call * @param methodName the method to call
* @param paramTypes the constructor parameter types, not cloned * @param paramTypes the constructor parameter types, not cloned

View File

@ -55,7 +55,7 @@ public final class MapTransformer<I, O> implements Transformer<I, O>, Serializab
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>mapTransformer</code> if you want that.
* *
* @param map the map to use for lookup, not cloned * @param map the map to use for lookup, not cloned
*/ */

View File

@ -47,7 +47,7 @@ public final class NOPClosure<E> implements Closure<E>, Serializable {
} }
/** /**
* Constructor * Constructor.
*/ */
private NOPClosure() { private NOPClosure() {
super(); super();

View File

@ -47,7 +47,7 @@ public class NOPTransformer<T> implements Transformer<T, T>, Serializable {
} }
/** /**
* Constructor * Constructor.
*/ */
private NOPTransformer() { private NOPTransformer() {
super(); super();

View File

@ -77,7 +77,7 @@ public final class NonePredicate<T> extends AbstractQuantifierPredicate<T> imple
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>nonePredicate</code> if you want that.
* *
* @param predicates the predicates to check, not cloned, not null * @param predicates the predicates to check, not cloned, not null
*/ */

View File

@ -51,7 +51,7 @@ public final class NotPredicate<T> implements Predicate<T>, PredicateDecorator<T
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>notPredicate</code> if you want that.
* *
* @param predicate the predicate to call after the null check * @param predicate the predicate to call after the null check
*/ */

View File

@ -52,7 +52,7 @@ public final class NullIsExceptionPredicate<T> implements Predicate<T>, Predicat
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>nullIsExceptionPredicate</code> if you want that.
* *
* @param predicate the predicate to call after the null check * @param predicate the predicate to call after the null check
*/ */

View File

@ -51,7 +51,7 @@ public final class NullIsFalsePredicate<T> implements Predicate<T>, PredicateDec
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>nullIsFalsePredicate</code> if you want that.
* *
* @param predicate the predicate to call after the null check * @param predicate the predicate to call after the null check
*/ */

View File

@ -51,7 +51,7 @@ public final class NullIsTruePredicate<T> implements Predicate<T>, PredicateDeco
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>nullIsTruePredicate</code> if you want that.
* *
* @param predicate the predicate to call after the null check * @param predicate the predicate to call after the null check
*/ */

View File

@ -77,7 +77,7 @@ public final class OnePredicate<T> extends AbstractQuantifierPredicate<T> implem
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>onePredicate</code> if you want that.
* *
* @param predicates the predicates to check, not cloned, not null * @param predicates the predicates to check, not cloned, not null
*/ */

View File

@ -55,7 +55,7 @@ public final class OrPredicate<T> implements Predicate<T>, PredicateDecorator<T>
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>orPredicate</code> if you want that.
* *
* @param predicate1 the first predicate to check, not null * @param predicate1 the first predicate to check, not null
* @param predicate2 the second predicate to check, not null * @param predicate2 the second predicate to check, not null

View File

@ -53,7 +53,7 @@ public class PredicateTransformer<T> implements Transformer<T, Boolean>, Seriali
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>predicateTransformer</code> if you want that.
* *
* @param predicate the predicate to call, not null * @param predicate the predicate to call, not null
*/ */

View File

@ -80,8 +80,7 @@ public class PrototypeFactory {
} }
/** /**
* Constructor that performs no validation. * Restricted constructor.
* Use <code>getInstance</code> if you want that.
*/ */
private PrototypeFactory() { private PrototypeFactory() {
super(); super();

View File

@ -109,7 +109,7 @@ public class SwitchClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>switchClosure</code> if you want that.
* *
* @param predicates array of predicates, not cloned, no nulls * @param predicates array of predicates, not cloned, no nulls
* @param closures matching array of closures, not cloned, no nulls * @param closures matching array of closures, not cloned, no nulls

View File

@ -121,7 +121,7 @@ public class SwitchTransformer<I, O> implements Transformer<I, O>, Serializable
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>switchTransformer</code> if you want that.
* *
* @param predicates array of predicates, not cloned, no nulls * @param predicates array of predicates, not cloned, no nulls
* @param transformers matching array of transformers, not cloned, no nulls * @param transformers matching array of transformers, not cloned, no nulls

View File

@ -61,7 +61,7 @@ public final class TransformedPredicate<T> implements Predicate<T>, PredicateDec
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>transformedPredicate</code> if you want that.
* *
* @param transformer the transformer to use * @param transformer the transformer to use
* @param predicate the predicate to decorate * @param predicate the predicate to decorate

View File

@ -54,7 +54,7 @@ public class TransformerClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>transformerClosure</code> if you want that.
* *
* @param transformer the transformer to call, not null * @param transformer the transformer to call, not null
*/ */

View File

@ -53,7 +53,7 @@ public final class TransformerPredicate<T> implements Predicate<T>, Serializable
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>transformerPredicate</code> if you want that.
* *
* @param transformer the transformer to decorate * @param transformer the transformer to decorate
*/ */

View File

@ -50,7 +50,7 @@ public final class UniquePredicate<T> implements Predicate<T>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>uniquePredicate</code> if you want that.
*/ */
public UniquePredicate() { public UniquePredicate() {
super(); super();

View File

@ -63,7 +63,7 @@ public class WhileClosure<E> implements Closure<E>, Serializable {
/** /**
* Constructor that performs no validation. * Constructor that performs no validation.
* Use <code>getInstance</code> if you want that. * Use <code>whileClosure</code> if you want that.
* *
* @param predicate the predicate used to evaluate when the loop terminates, not null * @param predicate the predicate used to evaluate when the loop terminates, not null
* @param closure the closure the execute, not null * @param closure the closure the execute, not null