public class

CustomMapEditor

extends PropertyEditorSupport
java.lang.Object
   ↳ java.beans.PropertyEditorSupport
     ↳ org.springframework.beans.propertyeditors.CustomMapEditor

Class Overview

Property editor for Maps, converting any source Map to a given target Map type.

See Also
  • Map
  • java.util.SortedMap

Summary

Public Constructors
CustomMapEditor(Class mapType)
Create a new CustomMapEditor for the given target type, keeping an incoming null as-is.
CustomMapEditor(Class mapType, boolean nullAsEmptyMap)
Create a new CustomMapEditor for the given target type.
Public Methods
String getAsText()
This implementation returns null to indicate that there is no appropriate text representation.
void setAsText(String text)
Convert the given text value to a Map with a single element.
void setValue(Object value)
Convert the given value to a Map of the target type.
Protected Methods
boolean alwaysCreateNewMap()
Return whether to always create a new Map, even if the type of the passed-in Map already matches.
Object convertKey(Object key)
Hook to convert each encountered Map key.
Object convertValue(Object value)
Hook to convert each encountered Map value.
Map createMap(Class mapType, int initialCapacity)
Create a Map of the given type, with the given initial capacity (if supported by the Map type).
[Expand]
Inherited Methods
From class java.beans.PropertyEditorSupport
From class java.lang.Object
From interface java.beans.PropertyEditor

Public Constructors

public CustomMapEditor (Class mapType)

Also: SpringBeans

Create a new CustomMapEditor for the given target type, keeping an incoming null as-is.

Parameters
mapType the target type, which needs to be a sub-interface of Map or a concrete Map class
See Also

public CustomMapEditor (Class mapType, boolean nullAsEmptyMap)

Also: SpringBeans

Create a new CustomMapEditor for the given target type.

If the incoming value is of the given type, it will be used as-is. If it is a different Map type or an array, it will be converted to a default implementation of the given Map type. If the value is anything else, a target Map with that single value will be created.

The default Map implementations are: TreeMap for SortedMap, and LinkedHashMap for Map.

Parameters
mapType the target type, which needs to be a sub-interface of Map or a concrete Map class
nullAsEmptyMap ap whether to convert an incoming null value to an empty Map (of the appropriate type)
See Also

Public Methods

public String getAsText ()

This implementation returns null to indicate that there is no appropriate text representation.

public void setAsText (String text)

Convert the given text value to a Map with a single element.

Throws
IllegalArgumentException

public void setValue (Object value)

Convert the given value to a Map of the target type.

Protected Methods

protected boolean alwaysCreateNewMap ()

Also: SpringBeans

Return whether to always create a new Map, even if the type of the passed-in Map already matches.

Default is "false"; can be overridden to enforce creation of a new Map, for example to convert elements in any case.

See Also

protected Object convertKey (Object key)

Also: SpringBeans

Hook to convert each encountered Map key. The default implementation simply returns the passed-in key as-is.

Can be overridden to perform conversion of certain keys, for example from String to Integer.

Only called if actually creating a new Map! This is by default not the case if the type of the passed-in Map already matches. Override alwaysCreateNewMap() to enforce creating a new Map in every case.

Parameters
key the source key
Returns
  • the key to be used in the target Map
See Also

protected Object convertValue (Object value)

Also: SpringBeans

Hook to convert each encountered Map value. The default implementation simply returns the passed-in value as-is.

Can be overridden to perform conversion of certain values, for example from String to Integer.

Only called if actually creating a new Map! This is by default not the case if the type of the passed-in Map already matches. Override alwaysCreateNewMap() to enforce creating a new Map in every case.

Parameters
value the source value
Returns
  • the value to be used in the target Map
See Also

protected Map createMap (Class mapType, int initialCapacity)

Also: SpringBeans

Create a Map of the given type, with the given initial capacity (if supported by the Map type).

Parameters
mapType a sub-interface of Map
initialCapacity the initial capacity
Returns
  • the new Map instance