Interface PropertyEditorRegistry
- All Known Subinterfaces:
BeanWrapper
,ConfigurablePropertyAccessor
- All Known Implementing Classes:
AbstractNestablePropertyAccessor
,AbstractPropertyAccessor
,BeanWrapperImpl
,DataBinder
,DirectFieldAccessor
,ExtendedServletRequestDataBinder
,PropertyEditorRegistrySupport
,ServletRequestDataBinder
,SimpleTypeConverter
,TypeConverterSupport
,WebDataBinder
,WebExchangeDataBinder
,WebRequestDataBinder
PropertyEditors
.
This is the central interface that a PropertyEditorRegistrar
operates on.
Extended by BeanWrapper
; implemented by BeanWrapperImpl
and DataBinder
.
- Since:
- 1.2.6
- Author:
- Juergen Hoeller
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionfindCustomEditor
(Class<?> requiredType, String propertyPath) Find a custom property editor for the given type and property.void
registerCustomEditor
(Class<?> requiredType, PropertyEditor propertyEditor) Register the given custom property editor for all properties of the given type.void
registerCustomEditor
(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor) Register the given custom property editor for the given type and property, or for all properties of the given type.
-
Method Details
-
registerCustomEditor
Register the given custom property editor for all properties of the given type.- Parameters:
requiredType
- the type of the propertypropertyEditor
- the editor to register
-
registerCustomEditor
void registerCustomEditor(@Nullable Class<?> requiredType, @Nullable String propertyPath, PropertyEditor propertyEditor) Register the given custom property editor for the given type and property, or for all properties of the given type.If the property path denotes an array or Collection property, the editor will get applied either to the array/Collection itself (the
PropertyEditor
has to create an array or Collection value) or to each element (thePropertyEditor
has to create the element type), depending on the specified required type.Note: Only one single registered custom editor per property path is supported. In the case of a Collection/array, do not register an editor for both the Collection/array and each element on the same property.
For example, if you wanted to register an editor for "items[n].quantity" (for all values n), you would use "items.quantity" as the value of the 'propertyPath' argument to this method.
- Parameters:
requiredType
- the type of the property. This may benull
if a property is given but should be specified in any case, in particular in case of a Collection - making clear whether the editor is supposed to apply to the entire Collection itself or to each of its entries. So as a general rule: Do not specifynull
here in case of a Collection/array!propertyPath
- the path of the property (name or nested path), ornull
if registering an editor for all properties of the given typepropertyEditor
- editor to register
-
findCustomEditor
@Nullable PropertyEditor findCustomEditor(@Nullable Class<?> requiredType, @Nullable String propertyPath) Find a custom property editor for the given type and property.- Parameters:
requiredType
- the type of the property (can benull
if a property is given but should be specified in any case for consistency checking)propertyPath
- the path of the property (name or nested path), ornull
if looking for an editor for all properties of the given type- Returns:
- the registered editor, or
null
if none
-