Package org.springframework.ui
Class ExtendedModelMap
- java.lang.Object
- java.util.AbstractMap<K,V>
- java.util.HashMap<K,V>
- java.util.LinkedHashMap<String,Object>
- org.springframework.ui.ModelMap
- org.springframework.ui.ExtendedModelMap
- Direct Known Subclasses:
BindingAwareModelMap
public class ExtendedModelMap extends ModelMap implements Model
Subclass ofModelMapthat implements theModelinterface. Java 5 specific like theModelinterface itself.This is an implementation class exposed to handler methods by Spring MVC, typically via a declaration of the
Modelinterface. There is no need to build it within user code; a plainModelMapor even a just a regularMapwith String keys will be good enough to return a user model.- Since:
- 2.5.1
- Author:
- Juergen Hoeller
- See Also:
- Serialized Form
Nested Class Summary
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
Constructor Summary
Constructors Constructor Description ExtendedModelMap()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExtendedModelMapaddAllAttributes(Collection<?> attributeValues)Copy all attributes in the suppliedCollectioninto thisMap, using attribute name generation for each element.ExtendedModelMapaddAllAttributes(Map<String,?> attributes)Copy all attributes in the suppliedMapinto thisMap.ExtendedModelMapaddAttribute(Object attributeValue)Add the supplied attribute to thisMapusing agenerated name.ExtendedModelMapaddAttribute(String attributeName, Object attributeValue)Add the supplied attribute under the supplied name.Map<String,Object>asMap()Return the current set of model attributes as a Map.ExtendedModelMapmergeAttributes(Map<String,?> attributes)Copy all attributes in the suppliedMapinto thisMap, with existing objects of the same name taking precedence (i.e.Methods inherited from class org.springframework.ui.ModelMap
containsAttribute
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values
Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size
Methods inherited from interface org.springframework.ui.Model
containsAttribute
Constructor Detail
ExtendedModelMap
public ExtendedModelMap()
Method Detail
addAttribute
public ExtendedModelMap addAttribute(String attributeName, Object attributeValue)
Description copied from class:ModelMapAdd the supplied attribute under the supplied name.- Specified by:
addAttributein interfaceModel- Overrides:
addAttributein classModelMap- Parameters:
attributeName- the name of the model attribute (nevernull)attributeValue- the model attribute value (can benull)
addAttribute
public ExtendedModelMap addAttribute(Object attributeValue)
Description copied from class:ModelMapAdd the supplied attribute to thisMapusing agenerated name.Note: Empty Collectionsare not added to the model when using this method because we cannot correctly determine the true convention name. View code should check fornullrather than for empty collections as is already done by JSTL tags.- Specified by:
addAttributein interfaceModel- Overrides:
addAttributein classModelMap- Parameters:
attributeValue- the model attribute value (nevernull)
addAllAttributes
public ExtendedModelMap addAllAttributes(Collection<?> attributeValues)
Description copied from class:ModelMapCopy all attributes in the suppliedCollectioninto thisMap, using attribute name generation for each element.- Specified by:
addAllAttributesin interfaceModel- Overrides:
addAllAttributesin classModelMap- See Also:
ModelMap.addAttribute(Object)
addAllAttributes
public ExtendedModelMap addAllAttributes(Map<String,?> attributes)
Description copied from class:ModelMapCopy all attributes in the suppliedMapinto thisMap.- Specified by:
addAllAttributesin interfaceModel- Overrides:
addAllAttributesin classModelMap- See Also:
ModelMap.addAttribute(String, Object)
mergeAttributes
public ExtendedModelMap mergeAttributes(Map<String,?> attributes)
Description copied from class:ModelMapCopy all attributes in the suppliedMapinto thisMap, with existing objects of the same name taking precedence (i.e. not getting replaced).- Specified by:
mergeAttributesin interfaceModel- Overrides:
mergeAttributesin classModelMap