net.sf.javagimmicks.cdi.CDISupplierProducer Maven / Gradle / Ivy

Go to download
package net.sf.javagimmicks.cdi;

import javax.enterprise.inject.spi.InjectionPoint;

import net.sf.javagimmicks.util.Supplier;

/**
 * A base class for writing CDI producers based on a given {@link Supplier} and
 * allowing advances instance configuration via {@link InjectionPoint}.
 * 
 * Subclasses should call {@link #produceInternal(InjectionPoint)} in their
 * producer methods and can provide custom configuration logic by overwriting
 * {@link #configure(Object, InjectionPoint)}.
 * 
 * @param 
 *           The type of beans to create
 */
public abstract class CDISupplierProducer
{
   private final Supplier _factory;

   /**
    * Creates a new instance around the given {@link Supplier}
    * 
    * @param factory
    *           the {@link Supplier} responsible for creating new bean instances
    */
   public CDISupplierProducer(final Supplier factory)
   {
      _factory = factory;
   }

   /**
    * Subclasses should call this method from the provided producer methods in
    * order to create a new bean instance optionally passing the CDI injected
    * {@link InjectionPoint}.
    * 
    * @param injectionPoint
    *           the CDI provided {@link InjectionPoint} the carries information
    *           about the injection point of the bean - if non-null then
    *           {@link #configure(Object, InjectionPoint)} will be called to
    *           configure the created bean instances based on the
    *           {@link InjectionPoint}
    * @return the produces (and optionally configured) bean
    */
   protected final E produceInternal(final InjectionPoint injectionPoint)
   {
      final E result = _factory.get();

      if (injectionPoint != null)
      {
         configure(result, injectionPoint);
      }

      return result;
   }

   protected void configure(final E newInstance, final InjectionPoint injectionPoint)
   {}
}