org.springframework.beans.factory.config

Class CustomEditorConfigurer

  • java.lang.Object
    • org.springframework.beans.factory.config.CustomEditorConfigurer
  • All Implemented Interfaces:
    BeanFactoryPostProcessor, Ordered


    public class CustomEditorConfigurer
    extends java.lang.Object
    implements BeanFactoryPostProcessor, Ordered
    BeanFactoryPostProcessor implementation that allows for convenient registration of custom property editors.

    In case you want to register PropertyEditor instances, the recommended usage as of Spring 2.0 is to use custom PropertyEditorRegistrar implementations that in turn register any desired editor instances on a given registry. Each PropertyEditorRegistrar can register any number of custom editors.

     <bean id="customEditorConfigurer" class="org.springframework.beans.factory.config.CustomEditorConfigurer">
       <property name="propertyEditorRegistrars">
         <list>
           <bean class="mypackage.MyCustomDateEditorRegistrar"/>
           <bean class="mypackage.MyObjectEditorRegistrar"/>
         </list>
       </property>
     </bean>
     

    It's perfectly fine to register PropertyEditor classes via the customEditors property. Spring will create fresh instances of them for each editing attempt then:

     <bean id="customEditorConfigurer" class="org.springframework.beans.factory.config.CustomEditorConfigurer">
       <property name="customEditors">
         <map>
           <entry key="java.util.Date" value="mypackage.MyCustomDateEditor"/>
           <entry key="mypackage.MyObject" value="mypackage.MyObjectEditor"/>
         </map>
       </property>
     </bean>
     

    Note, that you shouldn't register PropertyEditor bean instances via the customEditors property as PropertyEditors are stateful and the instances will then have to be synchronized for every editing attempt. In case you need control over the instantiation process of PropertyEditors, use a PropertyEditorRegistrar to register them.

    Also supports "java.lang.String[]"-style array class names and primitive class names (e.g. "boolean"). Delegates to ClassUtils for actual class name resolution.

    NOTE: Custom property editors registered with this configurer do not apply to data binding. Custom editors for data binding need to be registered on the DataBinder: Use a common base class or delegate to common PropertyEditorRegistrar implementations to reuse editor registration there.

    Since:
    27.02.2004
    Author:
    Juergen Hoeller
    See Also:
    PropertyEditor, PropertyEditorRegistrar, ConfigurableBeanFactory.addPropertyEditorRegistrar(org.springframework.beans.PropertyEditorRegistrar), ConfigurableBeanFactory.registerCustomEditor(java.lang.Class<?>, java.lang.Class<? extends java.beans.PropertyEditor>), DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor)