Class MapFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<Map<Object,Object>>

org.springframework.beans.factory.config.MapFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<Map<Object,Object>>, InitializingBean

public class MapFactoryBean
extends AbstractFactoryBean<Map<Object,Object>>

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

See Also:

• SetFactoryBean
• ListFactoryBean

Field Summary

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
MapFactoryBean()

Method Summary

Modifier and Type	Method	Description
protected Map<Object,Object>	createInstance()	Template method that subclasses must override to construct the object returned by this factory.
Class<Map>	getObjectType()	This abstract method declaration mirrors the method in the FactoryBean interface, for a consistent offering of abstract template methods.
void	setSourceMap(Map<?,?> sourceMap)	Set the source Map, typically populated via XML "map" elements.
void	setTargetMapClass(@Nullable Class<? extends Map> targetMapClass)	Set the class to use for the target Map.

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Details

MapFactoryBean

public MapFactoryBean()

Method Details

setSourceMap

public void setSourceMap(Map<?,?> sourceMap)

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

setTargetMapClass

public void setTargetMapClass(@Nullable Class<? extends Map> targetMapClass)

Set the class to use for the target Map. Can be populated with a fully qualified class name when defined in a Spring application context.

Default is a linked HashMap, keeping the registration order.

See Also:

• LinkedHashMap

getObjectType

public Class<Map> getObjectType()

Description copied from class: AbstractFactoryBean

This abstract method declaration mirrors the method in the FactoryBean interface, for a consistent offering of abstract template methods.

Specified by:

getObjectType in interface FactoryBean<Map<Object,Object>>

Specified by:

getObjectType in class AbstractFactoryBean<Map<Object,Object>>

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

• FactoryBean.getObjectType()

createInstance

protected Map<Object,Object> createInstance()

Description copied from class: AbstractFactoryBean

Template method that subclasses must override to construct the object returned by this factory.

Invoked on initialization of this FactoryBean in case of a singleton; else, on each AbstractFactoryBean.getObject() call.

Specified by:

createInstance in class AbstractFactoryBean<Map<Object,Object>>

Returns:

the object returned by this factory

See Also:

• AbstractFactoryBean.getObject()