| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.ui.freemarker.FreeMarkerConfigurationFactory
org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean
public class FreeMarkerConfigurationFactoryBean
Factory bean that creates a FreeMarker Configuration and provides it as bean reference. This bean is intended for any kind of usage of FreeMarker in application code, e.g. for generating email content. For web views, FreeMarkerConfigurer is used to set up a FreeMarkerConfigurationFactory. The simplest way to use this class is to specify just a "templateLoaderPath"; you do not need any further configuration then. For example, in a web application context:
<bean id="freemarkerConfiguration" class="org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean"> <property name="templateLoaderPath" value="/WEB-INF/freemarker/"/> </bean>See the base class FreeMarkerConfigurationFactory for configuration details.
Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
FreeMarkerConfigurationFactory.setConfigLocation(org.springframework.core.io.Resource), 
FreeMarkerConfigurationFactory.setFreemarkerSettings(java.util.Properties), 
FreeMarkerConfigurationFactory.setTemplateLoaderPath(java.lang.String), 
FreeMarkerConfigurer| Field Summary | 
|---|
| Fields inherited from class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory | 
|---|
| logger | 
| Constructor Summary | |
|---|---|
| FreeMarkerConfigurationFactoryBean() | |
| Method Summary | |
|---|---|
|  void | afterPropertiesSet()Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). | 
|  Object | getObject()Return an instance (possibly shared or independent) of the object managed by this factory. | 
|  Class | getObjectType()Return the type of object that this FactoryBean creates, or nullif not known in advance. | 
|  boolean | isSingleton()Is the object managed by this factory a singleton? | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface org.springframework.context.ResourceLoaderAware | 
|---|
| setResourceLoader | 
| Constructor Detail | 
|---|
public FreeMarkerConfigurationFactoryBean()
| Method Detail | 
|---|
public void afterPropertiesSet()
                        throws IOException,
                               TemplateException
InitializingBeanThis 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.
afterPropertiesSet in interface InitializingBeanIOException
TemplateExceptionpublic Object getObject()
FactoryBeanAs with a BeanFactory, this allows support for both the
 Singleton and Prototype design pattern.
 
If this FactoryBean is not fully initialized yet at the time of
 the call (for example because it is involved in a circular reference),
 throw a corresponding FactoryBeanNotInitializedException.
 
As of Spring 2.0, FactoryBeans are allowed to return null
 objects. The factory will consider this as normal value to be used; it
 will not throw a FactoryBeanNotInitializedException in this case anymore.
 FactoryBean implementations are encouraged to throw
 FactoryBeanNotInitializedException themselves now, as appropriate.
getObject in interface FactoryBeannull)FactoryBeanNotInitializedExceptionpublic Class getObjectType()
FactoryBeannull if not known in advance.
 This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
 null here. Therefore it is highly recommended to implement
 this method properly, using the current state of the FactoryBean.
getObjectType in interface FactoryBeannull if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class)public boolean isSingleton()
FactoryBeanFactoryBean.getObject() always return the same object
 (a reference that can be cached)?
 NOTE: If a FactoryBean indicates to hold a singleton object,
 the object returned from getObject() might get cached
 by the owning BeanFactory. Hence, do not return true
 unless the FactoryBean always exposes the same reference.
 
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false does not
 necessarily indicate that returned objects are independent instances.
 An implementation of the extended SmartFactoryBean interface
 may explicitly indicate independent instances through its
 SmartFactoryBean.isPrototype() method. Plain FactoryBean
 implementations which do not implement this extended interface are
 simply assumed to always return independent instances if the
 isSingleton() implementation returns false.
isSingleton in interface FactoryBeanFactoryBean.getObject(), 
SmartFactoryBean.isPrototype()| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||