org.springframework.format.support

Class FormattingConversionServiceFactoryBean

java.lang.Object

org.springframework.format.support.FormattingConversionServiceFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.FactoryBean<FormattingConversionService>, org.springframework.beans.factory.InitializingBean, EmbeddedValueResolverAware

public class FormattingConversionServiceFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<FormattingConversionService>, EmbeddedValueResolverAware, org.springframework.beans.factory.InitializingBean

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.

Since:

3.0

Author:

Keith Donald, Juergen Hoeller, Rossen Stoyanchev, Chris Beams

Constructor Summary

Constructors

Constructor and Description
FormattingConversionServiceFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
FormattingConversionService	getObject()
java.lang.Class<? extends FormattingConversionService>	getObjectType()
protected void	installFormatters(FormatterRegistry registry) Deprecated. since Spring 3.1 in favor of setFormatterRegistrars(Set)
boolean	isSingleton()
void	setConverters(java.util.Set<?> converters) Configure the set of custom converter objects that should be added.
void	setEmbeddedValueResolver(org.springframework.util.StringValueResolver embeddedValueResolver) Set the StringValueResolver to use for resolving embedded definition values.
void	setFormatterRegistrars(java.util.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(java.util.Set<?> formatters) Configure the set of custom formatter objects that should be added.
void	setRegisterDefaultFormatters(boolean registerDefaultFormatters) Indicate whether default formatters should be registered or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattingConversionServiceFactoryBean

public FormattingConversionServiceFactoryBean()

Method Detail

setConverters

public void setConverters(java.util.Set<?> converters)

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

Parameters:

converters - instances of any of the following: Converter, ConverterFactory, GenericConverter

setFormatters

public void setFormatters(java.util.Set<?> formatters)

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

Parameters:

formatters - instances of Formatter or AnnotationFormatterFactory

setFormatterRegistrars

public void setFormatterRegistrars(java.util.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.

See Also:

FormatterRegistry.addFormatterForFieldType(Class, Formatter), FormatterRegistry.addFormatterForFieldType(Class, Printer, Parser)

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.

See Also:

setFormatters(Set), setFormatterRegistrars(Set)

setEmbeddedValueResolver

public void setEmbeddedValueResolver(org.springframework.util.StringValueResolver embeddedValueResolver)

Description copied from interface: EmbeddedValueResolverAware

Set the StringValueResolver to use for resolving embedded definition values.

Specified by:

setEmbeddedValueResolver in interface EmbeddedValueResolverAware

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

installFormatters

@Deprecated
protected void installFormatters(FormatterRegistry registry)

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.

See Also:

setFormatters(Set), setFormatterRegistrars(Set)

getObject

public FormattingConversionService getObject()

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<FormattingConversionService>

getObjectType

public java.lang.Class<? extends FormattingConversionService> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<FormattingConversionService>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<FormattingConversionService>