Package org.apache.commons.collections

Class FactoryUtils

java.lang.Object
org.apache.commons.collections.FactoryUtils
@Deprecated(since="2021-04-30") public class FactoryUtils extends Object
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
FactoryUtils provides reference implementations and utilities for the Factory functor interface. The supplied factories are:
  • Prototype - clones a specified object
  • Reflection - creates objects using reflection
  • Constant - always returns the same object
  • Null - always returns null
  • Exception - always throws an exception
All the supplied factories are Serializable.
Since:
Commons Collections 3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    FactoryUtils()
    Deprecated.
    This class is not normally instantiated.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Factory
    constantFactory(Object constantToReturn)
    Deprecated.
    Creates a Factory that will return the same object each time the factory is used.
    static Factory
    exceptionFactory()
    Deprecated.
    Gets a Factory that always throws an exception.
    static Factory
    instantiateFactory(Class classToInstantiate)
    Deprecated.
    Creates a Factory that can create objects of a specific type using a no-args constructor.
    static Factory
    instantiateFactory(Class classToInstantiate, Class[] paramTypes, Object[] args)
    Deprecated.
    Creates a Factory that can create objects of a specific type using the arguments specified to this method.
    static Factory
    nullFactory()
    Deprecated.
    Gets a Factory that will return null each time the factory is used.
    static Factory
    prototypeFactory(Object prototype)
    Deprecated.
    Creates a Factory that will return a clone of the same prototype object each time the factory is used.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • FactoryUtils

      public FactoryUtils()
      Deprecated.
      This class is not normally instantiated.

  • Method Details

    • exceptionFactory

      public static Factory exceptionFactory()
      Deprecated.
      Gets a Factory that always throws an exception. This could be useful during testing as a placeholder.
      Returns:
      the factory
      See Also:

    • nullFactory

      public static Factory nullFactory()
      Deprecated.
      Gets a Factory that will return null each time the factory is used. This could be useful during testing as a placeholder.
      Returns:
      the factory
      See Also:

    • constantFactory

      public static Factory constantFactory(Object constantToReturn)
      Deprecated.
      Creates a Factory that will return the same object each time the factory is used. No check is made that the object is immutable. In general, only immutable objects should use the constant factory. Mutable objects should use the prototype factory.
      Parameters:
      constantToReturn - the constant object to return each time in the factory
      Returns:
      the constant factory.
      See Also:

    • prototypeFactory

      public static Factory prototypeFactory(Object prototype)
      Deprecated.
      Creates a Factory that will return a clone of the same prototype object each time the factory is used. The prototype will be cloned using one of these techniques (in order):
      • public clone method
      • public copy constructor
      • serialization clone
        Parameters:
        prototype - the object to clone each time in the factory
        Returns:
        the prototype factory
        Throws:
        IllegalArgumentException - if the prototype is null
        IllegalArgumentException - if the prototype cannot be cloned
        See Also:

      • instantiateFactory

        public static Factory instantiateFactory(Class classToInstantiate)
        Deprecated.
        Creates a Factory that can create objects of a specific type using a no-args constructor.
        Parameters:
        classToInstantiate - the Class to instantiate each time in the factory
        Returns:
        the reflection factory
        Throws:
        IllegalArgumentException - if the classToInstantiate is null
        See Also:

      • instantiateFactory

        public static Factory instantiateFactory(Class classToInstantiate, Class[] paramTypes, Object[] args)
        Deprecated.
        Creates a Factory that can create objects of a specific type using the arguments specified to this method.
        Parameters:
        classToInstantiate - the Class to instantiate each time in the factory
        paramTypes - parameter types for the constructor, can be null
        args - the arguments to pass to the constructor, can be null
        Returns:
        the reflection factory
        Throws:
        IllegalArgumentException - if the classToInstantiate is null
        IllegalArgumentException - if the paramTypes and args don't match
        IllegalArgumentException - if the constructor doesn't exist
        See Also: