tools.gsf.config

Class AbstractDelegatingFactory<SCOPE>

java.lang.Object

tools.gsf.config.AbstractDelegatingFactory<SCOPE>

All Implemented Interfaces:

Factory

Direct Known Subclasses:

IcsBackedFactory, ServletContextBackedFactory

public abstract class AbstractDelegatingFactory<SCOPE>
extends Object
implements Factory

This class caches the produced objects for the lifetime of this object. The object is located in subclasses by searching for methods annotated with the ServiceProducer annotation, whose return type is assignable from the class requested in the getObject(String,Class) method. NOTE: It does not require an exact match of the return type, only that it is assignable. Subclasses should not declare ambiguous ServiceProducer methods (without specifying a unique name) in the annotation, or else users may be surprised by which object is returned. It is possible to differentiate between two objects that are of the same type (or supertype) by using the name attribute on the ServiceProducer annotation. If provided, the name of the producer takes precedence over unnamed producer methods. If an object created in this factory is flagged as cached (using the cache attribute of the ServiceProducer annotation, the object will be cached against the name (if provided, or else the simple name of the requested type will be used) for the lifetime of this factory.

Since:

2016-08-06

Author:

Tony Field, Dolf Dijkstra

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDelegatingFactory(SCOPE scope, Factory delegate)

Method Summary

Modifier and Type	Method and Description
<T> T	getObject(String name, Class<T> fieldType) Return an object with the type specified.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDelegatingFactory

protected AbstractDelegatingFactory(SCOPE scope,
                                    Factory delegate)

Method Detail

getObject

public final <T> T getObject(String name,
                             Class<T> fieldType)

Description copied from interface: Factory

Return an object with the type specified. If a name is provided, more than one variant of the specified type could be returned.

Specified by:

getObject in interface Factory

Type Parameters:

T - the type of the object to return

Parameters:

name - the name used to identify the variant of the class to be returned. If no name is specified, then the class name of the type specified is assumed.

fieldType - the type of the oblject to return

Returns:

the matching object, or null if the factory does not know how to create the type specified.

toString

public String toString()

Overrides:

toString in class Object