Class FormattingConversionServiceFactoryBean
- All Implemented Interfaces:
Aware,FactoryBean<FormattingConversionService>,InitializingBean,EmbeddedValueResolverAware
FormattingConversionService
configured with converters and formatters for common types such as numbers and
datetimes.
Additional converters and formatters can be registered declaratively through
setConverters(Set) and setFormatters(Set). Another option
is to register converters and formatters in code by implementing the
FormatterRegistrar interface. You can then configure provide the set
of registrars to use through setFormatterRegistrars(Set).
A good example for registering converters and formatters in code is
JodaTimeFormatterRegistrar, which registers a number of
date-related formatters and converters. For a more detailed list of cases
see setFormatterRegistrars(Set)
Like all FactoryBean implementations, this class is suitable for
use when configuring a Spring application context using Spring <beans>
XML. When configuring the container with
@Configuration
classes, simply instantiate, configure and return the appropriate
FormattingConversionService object from a
@Bean method.
- Since:
- 3.0
- Author:
- Keith Donald, Juergen Hoeller, Rossen Stoyanchev, Chris Beams
-
Field Summary
Fields inherited from interface org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.Return an instance (possibly shared or independent) of the object managed by this factory.Class<? extends FormattingConversionService>Return the type of object that this FactoryBean creates, ornullif not known in advance.booleanIs the object managed by this factory a singleton? That is, willFactoryBean.getObject()always return the same object (a reference that can be cached)?voidsetConverters(Set<?> converters) Configure the set of custom converter objects that should be added.voidsetEmbeddedValueResolver(StringValueResolver embeddedValueResolver) Set the StringValueResolver to use for resolving embedded definition values.voidsetFormatterRegistrars(Set<FormatterRegistrar> formatterRegistrars) Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively viasetConverters(Set)andsetFormatters(Set).voidsetFormatters(Set<?> formatters) Configure the set of custom formatter objects that should be added.voidsetRegisterDefaultFormatters(boolean registerDefaultFormatters) Indicate whether default formatters should be registered or not.
-
Constructor Details
-
FormattingConversionServiceFactoryBean
public FormattingConversionServiceFactoryBean()
-
-
Method Details
-
setConverters
Configure the set of custom converter objects that should be added.- Parameters:
converters- instances of any of the following:Converter,ConverterFactory,GenericConverter
-
setFormatters
Configure the set of custom formatter objects that should be added.- Parameters:
formatters- instances ofFormatterorAnnotationFormatterFactory
-
setFormatterRegistrars
Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively via
setConverters(Set)andsetFormatters(Set).FormatterRegistrars are useful when registering multiple related converters and formatters for a formatting category, such as Date formatting. All types related needed to support the formatting category can be registered from one place.
FormatterRegistrars can also be used to register Formatters indexed under a specific field type different from its own <T>, or when registering a Formatter from a Printer/Parser pair.
-
setRegisterDefaultFormatters
public void setRegisterDefaultFormatters(boolean registerDefaultFormatters) Indicate whether default formatters should be registered or not.By default, built-in formatters are registered. This flag can be used to turn that off and rely on explicitly registered formatters only.
-
setEmbeddedValueResolver
Description copied from interface:EmbeddedValueResolverAwareSet the StringValueResolver to use for resolving embedded definition values.- Specified by:
setEmbeddedValueResolverin interfaceEmbeddedValueResolverAware
-
afterPropertiesSet
public void afterPropertiesSet()Description copied from interface:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSetin interfaceInitializingBean
-
getObject
Description copied from interface:FactoryBeanReturn 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.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
nullobjects. 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.- Specified by:
getObjectin interfaceFactoryBean<FormattingConversionService>- Returns:
- an instance of the bean (can be
null) - See Also:
-
getObjectType
Description copied from interface:FactoryBeanReturn the type of object that this FactoryBean creates, ornullif 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
nullhere. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.- Specified by:
getObjectTypein interfaceFactoryBean<FormattingConversionService>- Returns:
- the type of object that this FactoryBean creates,
or
nullif not known at the time of the call - See Also:
-
isSingleton
public boolean isSingleton()Description copied from interface:FactoryBeanIs the object managed by this factory a singleton? That is, willFactoryBean.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 returntrueunless 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
falsedoes not necessarily indicate that returned objects are independent instances. An implementation of the extendedSmartFactoryBeaninterface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()method. PlainFactoryBeanimplementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()implementation returnsfalse.The default implementation returns
true, since aFactoryBeantypically manages a singleton instance.- Specified by:
isSingletonin interfaceFactoryBean<FormattingConversionService>- Returns:
- whether the exposed object is a singleton
- See Also:
-