Class ExtendedModelMap

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

java.util.LinkedHashMap<String,Object>

org.springframework.ui.ModelMap

org.springframework.ui.ExtendedModelMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, SequencedMap<String,Object>, Model

Direct Known Subclasses:

BindingAwareModelMap

public class ExtendedModelMap
extends ModelMap
implements Model

Subclass of ModelMap that implements the Model interface.

This is an implementation class exposed to handler methods by Spring MVC, typically via a declaration of the Model interface. There is no need to build it within user code; a plain ModelMap or even a just a regular Map with 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 AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
ExtendedModelMap()

Method Summary

Modifier and Type	Method	Description
ExtendedModelMap	addAllAttributes(@Nullable Collection<?> attributeValues)	Copy all attributes in the supplied Collection into this Map, using attribute name generation for each element.
ExtendedModelMap	addAllAttributes(@Nullable Map<String,?> attributes)	Copy all attributes in the supplied Map into this Map.
ExtendedModelMap	addAttribute(Object attributeValue)	Add the supplied attribute to this Map using a generated name.
ExtendedModelMap	addAttribute(String attributeName, @Nullable Object attributeValue)	Add the supplied attribute under the supplied name.
Map<String,Object>	asMap()	Return the current set of model attributes as a Map.
ExtendedModelMap	mergeAttributes(@Nullable Map<String,?> attributes)	Copy all attributes in the supplied Map into this Map, with existing objects of the same name taking precedence (i.e.

Methods inherited from class ModelMap

containsAttribute, getAttribute

Methods inherited from class LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class AbstractMap

equals, hashCode, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from interface Model

containsAttribute, getAttribute

Methods inherited from interface SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Constructor Details

ExtendedModelMap

public ExtendedModelMap()

Method Details

addAttribute

public ExtendedModelMap addAttribute(String attributeName,
 @Nullable Object attributeValue)

Description copied from class: ModelMap

Add the supplied attribute under the supplied name.

Specified by:

addAttribute in interface Model

Overrides:

addAttribute in class ModelMap

Parameters:

attributeName - the name of the model attribute (never null)

attributeValue - the model attribute value (can be null)

addAttribute

public ExtendedModelMap addAttribute(Object attributeValue)

Description copied from class: ModelMap

Add the supplied attribute to this Map using a generated name.

Note: Empty Collections are not added to the model when using this method because we cannot correctly determine the true convention name. View code should check for null rather than for empty collections as is already done by JSTL tags.

Specified by:

addAttribute in interface Model

Overrides:

addAttribute in class ModelMap

Parameters:

attributeValue - the model attribute value (never null)

addAllAttributes

public ExtendedModelMap addAllAttributes(@Nullable Collection<?> attributeValues)

Description copied from class: ModelMap

Copy all attributes in the supplied Collection into this Map, using attribute name generation for each element.

Specified by:

addAllAttributes in interface Model

Overrides:

addAllAttributes in class ModelMap

See Also:

• ModelMap.addAttribute(Object)

addAllAttributes

public ExtendedModelMap addAllAttributes(@Nullable Map<String,?> attributes)

Description copied from class: ModelMap

Copy all attributes in the supplied Map into this Map.

Specified by:

addAllAttributes in interface Model

Overrides:

addAllAttributes in class ModelMap

See Also:

• ModelMap.addAttribute(String, Object)

mergeAttributes

public ExtendedModelMap mergeAttributes(@Nullable Map<String,?> attributes)

Description copied from class: ModelMap

Copy all attributes in the supplied Map into this Map, with existing objects of the same name taking precedence (i.e. not getting replaced).

Specified by:

mergeAttributes in interface Model

Overrides:

mergeAttributes in class ModelMap

asMap

public Map<String,Object> asMap()

Description copied from interface: Model

Return the current set of model attributes as a Map.

Specified by:

asMap in interface Model