public class

FormattingConversionServiceFactoryBean

extends Object
implements FactoryBean<T> InitializingBean EmbeddedValueResolverAware
java.lang.Object
   ↳ org.springframework.format.support.FormattingConversionServiceFactoryBean

Class Overview

A factory providing convenient access to a 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.

Summary

Public Constructors
FormattingConversionServiceFactoryBean()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
FormattingConversionService getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.
Class<? extends FormattingConversionService> getObjectType()
Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean isSingleton()
Is the object managed by this factory a singleton? That is, will 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.

void setConverters(Set<?> converters)
Configure the set of custom converter objects that should be added.
void setEmbeddedValueResolver(StringValueResolver embeddedValueResolver)
Set the StringValueResolver to use for resolving embedded definition values.
void setFormatterRegistrars(Set<FormatterRegistrar> formatterRegistrars)

Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively via setConverters(Set) and setFormatters(Set).

void setFormatters(Set<?> formatters)
Configure the set of custom formatter objects that should be added.
void setRegisterDefaultFormatters(boolean registerDefaultFormatters)
Indicates whether default formatters should be registered or not.
Protected Methods
void installFormatters(FormatterRegistry registry)
This method is deprecated. since Spring 3.1 in favor of setFormatterRegistrars(Set)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.FactoryBean
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.EmbeddedValueResolverAware

Public Constructors

public FormattingConversionServiceFactoryBean ()

Public Methods

public void afterPropertiesSet ()

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.

public FormattingConversionService getObject ()

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.

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.

Returns
  • an instance of the bean (can be null)

public Class<? extends FormattingConversionService> getObjectType ()

Return the type of object that this FactoryBean creates, or null 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.

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

public boolean isSingleton ()

Is the object managed by this factory a singleton? That is, will 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 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.

Returns
  • whether the exposed object is a singleton

public void setConverters (Set<?> converters)

Configure the set of custom converter objects that should be added.

Parameters
converters instances of any of the following: Converter, ConverterFactory, GenericConverter.

public void setEmbeddedValueResolver (StringValueResolver embeddedValueResolver)

Set the StringValueResolver to use for resolving embedded definition values.

public void setFormatterRegistrars (Set<FormatterRegistrar> formatterRegistrars)

Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively via setConverters(Set) and setFormatters(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.

public void setFormatters (Set<?> formatters)

Configure the set of custom formatter objects that should be added.

Parameters
formatters instances of Formatter or AnnotationFormatterFactory.

public void setRegisterDefaultFormatters (boolean registerDefaultFormatters)

Indicates 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.

Protected Methods

protected void installFormatters (FormatterRegistry registry)

This method is deprecated.
since Spring 3.1 in favor of setFormatterRegistrars(Set)

Subclasses may override this method to register formatters and/or converters. Starting with Spring 3.1 however the recommended way of doing that is to through FormatterRegistrars.