org.springframework.beans.factory.config
Class MapFactoryBean

java.lang.Object
  org.springframework.beans.factory.config.MapFactoryBean

All Implemented Interfaces:

FactoryBean, InitializingBean

public class MapFactoryBean

extends java.lang.Object

implements FactoryBean, InitializingBean

Simple factory for shared Map instances. Allows for central setup of Maps via the "map" element in XML bean definitions.

Since:

09.12.2003

Author:

Juergen Hoeller

Constructor Summary

MapFactoryBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
java.lang.Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?
void	setSingleton(boolean singleton) Set if a singleton should be created, or a new object on each request else.
void	setSourceMap(java.util.Map sourceMap) Set the source Map, typically populated via XML "map" elements.
void	setTargetMapClass(java.lang.Class targetMapClass) Set the class to use for the target Map.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapFactoryBean

public MapFactoryBean()

Method Detail

setSourceMap

public void setSourceMap(java.util.Map sourceMap)

Set the source Map, typically populated via XML "map" elements.

setTargetMapClass

public void setTargetMapClass(java.lang.Class targetMapClass)

Set the class to use for the target Map. Default is java.util.HashMap.

See Also:

HashMap

setSingleton

public void setSingleton(boolean singleton)

Set if a singleton should be created, or a new object on each request else. Default is true.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

getObject

public java.lang.Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should never be null)

getObjectType

public java.lang.Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, e.g. on autowiring.

For a singleton, this can simply return getObject().getClass(), or even null, as autowiring will always check the actual objects for singletons. For prototypes, returning a meaningful type here is highly advisable, as autowiring will simply ignore them else.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class, boolean, boolean)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton