org.glassfish.hk2.api

Interface Factory<T>

Type Parameters:

T - This must be the type of entity for which this is a factory. For example, if this were a factory for Foo, then your factory must implement Factory<Foo>.

@Contract
public interface Factory<T>

This interface should be implemented in order to provide a factory for another type. This is useful when the type has some reason that it cannot be a created in the usual way.

A factory may not have a TypeVariable or a Wildcard as its actual type. A factory may have any scope, and the scope of the factory is independent of the scope of the type it is providing.

The scope and qualifiers of the objects this factory is producing must be placed on the provide method itself. Objects created with this method will be put into the scope on the provide method, and will have the qualifiers of the provide method.

A factory is generally added with the FactoryDescriptors helper class, though factories can also be registered independently.

Author:

jwells

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose(T instance) This method will dispose of objects created with this scope.
T	provide() This method will create instances of the type of this factory.

Method Detail

provide

T provide()

This method will create instances of the type of this factory. The provide method must be annotated with the desired scope and qualifiers.

Returns:

The produces object

dispose

void dispose(T instance)

This method will dispose of objects created with this scope. This method should not be annotated, as it is naturally paired with the provide method

Parameters:

instance - The instance to dispose of