Spring Framework 6.1.4 · org.springframework.beans.PropertyEditorRegistrySupport

Modifier and Type	Class and Description
private static class	PropertyEditorRegistrySupport.CustomEditorHolder Holder for a registered custom editor with property name.

Modifier and Type	Field and Description
private boolean	configValueEditorsActive
private ConversionService	conversionService
private Map<Class<?>, PropertyEditor>	customEditorCache
private Map<Class<?>, PropertyEditor>	customEditors
private Map<String, PropertyEditorRegistrySupport.CustomEditorHolder>	customEditorsForPath
private Map<Class<?>, PropertyEditor>	defaultEditors
private boolean	defaultEditorsActive
private Map<Class<?>, PropertyEditor>	overriddenDefaultEditors

Access	Constructor and Description
public	PropertyEditorRegistrySupport()

Method Summary

Modifier and Type	Method and Description
private void	addStrippedPropertyPaths(List<String> the result list to add to strippedPaths, String the current nested path nestedPath, String the property path to check for keys/indexes to strip propertyPath) Add property paths with all variations of stripped keys and/or indexes.
protected void	copyCustomEditorsTo(PropertyEditorRegistry the target registry to copy to target, String the nested property path of the target registry, if any. If this is non-null, only editors registered for a path below this nested property will be copied. If this is null, all editors will be copied. nestedProperty) Copy the custom editors registered in this instance to the given target registry.
protected void	copyDefaultEditorsTo(PropertyEditorRegistrySupport the target registry to copy to target) Copy the default editors registered in this instance to the given target registry.
private void	createDefaultEditors() Actually register the default editors for this registry instance.
public PropertyEditor	findCustomEditor(Class<?> the type of the property (can be `null` if a property is given but should be specified in any case for consistency checking) requiredType, String the path of the property (name or nested path), or `null` if looking for an editor for all properties of the given type propertyPath) Implements org.springframework.beans.PropertyEditorRegistry.findCustomEditor. Find a custom property editor for the given type and property.
public ConversionService	getConversionService() Return the associated ConversionService, if any.
private PropertyEditor	Returns: the custom editor, or `null` if none specific for this property getCustomEditor(String the property path to look for propertyName, Class<?> the type to look for requiredType) Get custom editor that has been registered for the given property.
private PropertyEditor	Returns: the custom editor, or `null` if none found for this type getCustomEditor(Class<?> the type to look for requiredType) Get custom editor for the given type.
public PropertyEditor	Returns: the default editor, or `null` if none found getDefaultEditor(Class<?> type of the property requiredType) Retrieve the default editor for the given property type, if any.
protected Class<?>	Returns: the type of the property, or `null` if not determinable getPropertyType(String the property path to determine the type for propertyPath) Determine the property type for the given property path.
protected Class<?>	Returns: the property type, or `null` if not determinable guessPropertyTypeFromEditors(String the name of the property propertyName) Guess the property type of the specified property from the registered custom editors (provided that they were registered for a specific type).
public boolean	Returns: whether a matching custom editor has been found hasCustomEditorForElement(Class<?> the target type of the element (can be `null` if not known) elementType, String the property path (typically of the array/collection; can be `null` if not known) propertyPath) Determine whether this registry contains a custom editor for the specified array/collection element.
public void	overrideDefaultEditor(Class<?> the type of the property requiredType, PropertyEditor the editor to register propertyEditor) Override the default editor for the specified type with the given property editor.
public void	registerCustomEditor(Class<?> the type of the property requiredType, PropertyEditor the editor to register propertyEditor) Implements org.springframework.beans.PropertyEditorRegistry.registerCustomEditor. Register the given custom property editor for all properties of the given type.
public void	registerCustomEditor(Class<?> the type of the property. This may be `null` 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 specify `null` here in case of a Collection/array! requiredType, String the path of the property (name or nested path), or `null` if registering an editor for all properties of the given type propertyPath, PropertyEditor editor to register propertyEditor) Implements org.springframework.beans.PropertyEditorRegistry.registerCustomEditor. Register the given custom property editor for the given type and property, or for all properties of the given type.
protected void	registerDefaultEditors() Activate the default editors for this registry instance, allowing for lazily registering default editors when needed.
public void	setConversionService(ConversionService conversionService) Specify a `ConversionService` to use for converting property values, as an alternative to JavaBeans PropertyEditors.
public void	useConfigValueEditors() Activate config value editors which are only intended for configuration purposes, such as `org.springframework.beans.propertyeditors.StringArrayPropertyEditor`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

configValueEditorsActive	back to summary
private boolean configValueEditorsActive

conversionService	back to summary
private ConversionService conversionService Annotations @Nullable

customEditorCache	back to summary
private Map<Class<?>, PropertyEditor> customEditorCache Annotations @Nullable

customEditors	back to summary
private Map<Class<?>, PropertyEditor> customEditors Annotations @Nullable

customEditorsForPath	back to summary
private Map<String, PropertyEditorRegistrySupport.CustomEditorHolder> customEditorsForPath Annotations @Nullable

defaultEditors	back to summary
private Map<Class<?>, PropertyEditor> defaultEditors Annotations @Nullable

defaultEditorsActive	back to summary
private boolean defaultEditorsActive

overriddenDefaultEditors	back to summary
private Map<Class<?>, PropertyEditor> overriddenDefaultEditors Annotations @Nullable

PropertyEditorRegistrySupport	back to summary
public PropertyEditorRegistrySupport()

Method Detail

addStrippedPropertyPaths	back to summary
private void addStrippedPropertyPaths(List<String> strippedPaths, String nestedPath, String propertyPath) Add property paths with all variations of stripped keys and/or indexes. Invokes itself recursively with nested paths. Parameters strippedPaths:List<String> the result list to add to nestedPath:String the current nested path propertyPath:String the property path to check for keys/indexes to strip

addStrippedPropertyPaths

back to summary

private void addStrippedPropertyPaths(List<String> strippedPaths, String nestedPath, String propertyPath)

Add property paths with all variations of stripped keys and/or indexes. Invokes itself recursively with nested paths.

Parameters

strippedPaths:List<String>: the result list to add to
nestedPath:String: the current nested path
propertyPath:String: the property path to check for keys/indexes to strip

copyCustomEditorsTo	back to summary
protected void copyCustomEditorsTo(PropertyEditorRegistry target, String nestedProperty) Copy the custom editors registered in this instance to the given target registry. Parameters target:PropertyEditorRegistry the target registry to copy to nestedProperty:String the nested property path of the target registry, if any. If this is non-null, only editors registered for a path below this nested property will be copied. If this is null, all editors will be copied.

copyCustomEditorsTo

back to summary

protected void copyCustomEditorsTo(PropertyEditorRegistry target, String nestedProperty)

Copy the custom editors registered in this instance to the given target registry.

Parameters

target:PropertyEditorRegistry: the target registry to copy to
nestedProperty:String: the nested property path of the target registry, if any. If this is non-null, only editors registered for a path below this nested property will be copied. If this is null, all editors will be copied.

copyDefaultEditorsTo	back to summary
protected void copyDefaultEditorsTo(PropertyEditorRegistrySupport target) Copy the default editors registered in this instance to the given target registry. Parameters target:PropertyEditorRegistrySupport the target registry to copy to

copyDefaultEditorsTo

back to summary

protected void copyDefaultEditorsTo(PropertyEditorRegistrySupport target)

Copy the default editors registered in this instance to the given target registry.

Parameters

target:PropertyEditorRegistrySupport: the target registry to copy to

createDefaultEditors	back to summary
private void createDefaultEditors() Actually register the default editors for this registry instance.

findCustomEditor back to summary

findCustomEditor	back to summary
public PropertyEditor findCustomEditor(Class<?> requiredType, String propertyPath) Implements org.springframework.beans.PropertyEditorRegistry.findCustomEditor. Doc from org.springframework.beans.PropertyEditorRegistry.findCustomEditor. Find a custom property editor for the given type and property. Parameters requiredType:Class<?> the type of the property (can be `null` if a property is given but should be specified in any case for consistency checking) propertyPath:String the path of the property (name or nested path), or `null` if looking for an editor for all properties of the given type Returns:PropertyEditor the registered editor, or `null` if none Annotations @Override @Nullable

public PropertyEditor findCustomEditor(Class<?> requiredType, String propertyPath)

Implements org.springframework.beans.PropertyEditorRegistry.findCustomEditor.

Doc from org.springframework.beans.PropertyEditorRegistry.findCustomEditor.

Find a custom property editor for the given type and property.

Parameters

requiredType:Class<?>: the type of the property (can be null if a property is given but should be specified in any case for consistency checking)
propertyPath:String: the path of the property (name or nested path), or null if looking for an editor for all properties of the given type

Returns:PropertyEditor

the registered editor, or null if none

Annotations

@Override
@Nullable

getConversionService	back to summary
public ConversionService getConversionService() Return the associated ConversionService, if any. Annotations @Nullable

getConversionService

back to summary

public ConversionService getConversionService()

Return the associated ConversionService, if any.

Annotations

@Nullable

getCustomEditor back to summary

getCustomEditor	back to summary
private PropertyEditor getCustomEditor(String propertyName, Class<?> requiredType) Get custom editor that has been registered for the given property. Parameters propertyName:String the property path to look for requiredType:Class<?> the type to look for Returns:PropertyEditor the custom editor, or `null` if none specific for this property Annotations @Nullable

private PropertyEditor getCustomEditor(String propertyName, Class<?> requiredType)

Get custom editor that has been registered for the given property.

Parameters

propertyName:String: the property path to look for
requiredType:Class<?>: the type to look for

Returns:PropertyEditor

the custom editor, or null if none specific for this property

Annotations

@Nullable

getCustomEditor back to summary

getCustomEditor	back to summary
private PropertyEditor getCustomEditor(Class<?> requiredType) Get custom editor for the given type. If no direct match found, try custom editor for superclass (which will in any case be able to render a value as String via `getAsText`). Parameters requiredType:Class<?> the type to look for Returns:PropertyEditor the custom editor, or `null` if none found for this type Annotations @Nullable See Also `java.beans.PropertyEditor#getAsText()`

private PropertyEditor getCustomEditor(Class<?> requiredType)

Get custom editor for the given type. If no direct match found, try custom editor for superclass (which will in any case be able to render a value as String via getAsText).

Parameters

requiredType:Class<?>: the type to look for

Returns:PropertyEditor

the custom editor, or null if none found for this type

Annotations

@Nullable

See Also

java.beans.PropertyEditor#getAsText()

getDefaultEditor back to summary

getDefaultEditor	back to summary
public PropertyEditor getDefaultEditor(Class<?> requiredType) Retrieve the default editor for the given property type, if any. Lazily registers the default editors, if they are active. Parameters requiredType:Class<?> type of the property Returns:PropertyEditor the default editor, or `null` if none found Annotations @Nullable See Also `registerDefaultEditors`

public PropertyEditor getDefaultEditor(Class<?> requiredType)

Retrieve the default editor for the given property type, if any.

Lazily registers the default editors, if they are active.

Parameters

requiredType:Class<?>: type of the property

Returns:PropertyEditor

the default editor, or null if none found

Annotations

@Nullable

See Also

registerDefaultEditors

getPropertyType back to summary

getPropertyType	back to summary
protected Class<?> getPropertyType(String propertyPath) Determine the property type for the given property path. Called by `findCustomEditor` if no required type has been specified, to be able to find a type-specific editor even if just given a property path. The default implementation always returns `null`. BeanWrapperImpl overrides this with the standard `getPropertyType` method as defined by the BeanWrapper interface. Parameters propertyPath:String the property path to determine the type for Returns:Class<?> the type of the property, or `null` if not determinable Annotations @Nullable See Also `BeanWrapper#getPropertyType(String)`

protected Class<?> getPropertyType(String propertyPath)

Determine the property type for the given property path.

Called by findCustomEditor if no required type has been specified, to be able to find a type-specific editor even if just given a property path.

The default implementation always returns null. BeanWrapperImpl overrides this with the standard getPropertyType method as defined by the BeanWrapper interface.

Parameters

propertyPath:String: the property path to determine the type for

Returns:Class<?>

the type of the property, or null if not determinable

Annotations

@Nullable

See Also

BeanWrapper#getPropertyType(String)

guessPropertyTypeFromEditors back to summary

guessPropertyTypeFromEditors	back to summary
protected Class<?> guessPropertyTypeFromEditors(String propertyName) Guess the property type of the specified property from the registered custom editors (provided that they were registered for a specific type). Parameters propertyName:String the name of the property Returns:Class<?> the property type, or `null` if not determinable Annotations @Nullable

protected Class<?> guessPropertyTypeFromEditors(String propertyName)

Guess the property type of the specified property from the registered custom editors (provided that they were registered for a specific type).

Parameters

propertyName:String: the name of the property

Returns:Class<?>

the property type, or null if not determinable

Annotations

@Nullable

hasCustomEditorForElement back to summary

hasCustomEditorForElement	back to summary
public boolean hasCustomEditorForElement(Class<?> elementType, String propertyPath) Determine whether this registry contains a custom editor for the specified array/collection element. Parameters elementType:Class<?> the target type of the element (can be `null` if not known) propertyPath:String the property path (typically of the array/collection; can be `null` if not known) Returns:boolean whether a matching custom editor has been found

public boolean hasCustomEditorForElement(Class<?> elementType, String propertyPath)

Determine whether this registry contains a custom editor for the specified array/collection element.

Parameters

elementType:Class<?>: the target type of the element (can be null if not known)
propertyPath:String: the property path (typically of the array/collection; can be null if not known)

Returns:boolean

whether a matching custom editor has been found

overrideDefaultEditor back to summary

overrideDefaultEditor	back to summary
public void overrideDefaultEditor(Class<?> requiredType, PropertyEditor propertyEditor) Override the default editor for the specified type with the given property editor. Note that this is different from registering a custom editor in that the editor semantically still is a default editor. A ConversionService will override such a default editor, whereas custom editors usually override the ConversionService. Parameters requiredType:Class<?> the type of the property propertyEditor:PropertyEditor the editor to register See Also `registerCustomEditor(Class, PropertyEditor)`

public void overrideDefaultEditor(Class<?> requiredType, PropertyEditor propertyEditor)

Override the default editor for the specified type with the given property editor.

Note that this is different from registering a custom editor in that the editor semantically still is a default editor. A ConversionService will override such a default editor, whereas custom editors usually override the ConversionService.

Parameters

requiredType:Class<?>: the type of the property
propertyEditor:PropertyEditor: the editor to register

registerCustomEditor	back to summary
public void registerCustomEditor(Class<?> requiredType, PropertyEditor propertyEditor) Implements org.springframework.beans.PropertyEditorRegistry.registerCustomEditor. Doc from org.springframework.beans.PropertyEditorRegistry.registerCustomEditor. Register the given custom property editor for all properties of the given type. Parameters requiredType:Class<?> the type of the property propertyEditor:PropertyEditor the editor to register Annotations @Override

registerCustomEditor

back to summary

public void registerCustomEditor(Class<?> requiredType, PropertyEditor propertyEditor)

Implements org.springframework.beans.PropertyEditorRegistry.registerCustomEditor.

Doc from org.springframework.beans.PropertyEditorRegistry.registerCustomEditor.

Parameters

requiredType:Class<?>: the type of the property
propertyEditor:PropertyEditor: the editor to register

Annotations

@Override

registerCustomEditor back to summary

registerCustomEditor	back to summary
public void registerCustomEditor(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor) Implements org.springframework.beans.PropertyEditorRegistry.registerCustomEditor. Doc from org.springframework.beans.PropertyEditorRegistry.registerCustomEditor. 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 (the `PropertyEditor` 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:Class<?> the type of the property. This may be `null` 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 specify `null` here in case of a Collection/array! propertyPath:String the path of the property (name or nested path), or `null` if registering an editor for all properties of the given type propertyEditor:PropertyEditor editor to register Annotations @Override

public void registerCustomEditor(Class<?> requiredType, String propertyPath, PropertyEditor propertyEditor)

Implements org.springframework.beans.PropertyEditorRegistry.registerCustomEditor.

Doc from org.springframework.beans.PropertyEditorRegistry.registerCustomEditor.

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 (the PropertyEditor 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:Class<?>: the type of the property. This may be null 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 specify null here in case of a Collection/array!
propertyPath:String: the path of the property (name or nested path), or null if registering an editor for all properties of the given type
propertyEditor:PropertyEditor: editor to register

Annotations

@Override

registerDefaultEditors	back to summary
protected void registerDefaultEditors() Activate the default editors for this registry instance, allowing for lazily registering default editors when needed.

setConversionService	back to summary
public void setConversionService(ConversionService conversionService) Specify a `ConversionService` to use for converting property values, as an alternative to JavaBeans PropertyEditors.

useConfigValueEditors back to summary

useConfigValueEditors	back to summary
public void useConfigValueEditors() Activate config value editors which are only intended for configuration purposes, such as `org.springframework.beans.propertyeditors.StringArrayPropertyEditor`. Those editors are not registered by default simply because they are in general inappropriate for data binding purposes. Of course, you may register them individually in any case, through `registerCustomEditor`.

public void useConfigValueEditors()

Activate config value editors which are only intended for configuration purposes, such as org.springframework.beans.propertyeditors.StringArrayPropertyEditor.

Those editors are not registered by default simply because they are in general inappropriate for data binding purposes. Of course, you may register them individually in any case, through registerCustomEditor.

public Class PropertyEditorRegistrySupport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PropertyEditorRegistrySupport.CustomEditorHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final PropertyEditor	propertyEditor
private final Class<?>	registeredType

Modifier and Type	Method and Description
private PropertyEditor	getPropertyEditor()
private PropertyEditor	getPropertyEditor(Class<?> requiredType)
private Class<?>	getRegisteredType()