The Spring Framework

org.springframework.ui
Class ExtendedModelMap

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<K,V>
          extended by java.util.LinkedHashMap
              extended by org.springframework.ui.ModelMap
                  extended by org.springframework.ui.ExtendedModelMap
All Implemented Interfaces:
Serializable, Cloneable, Map, Model

public class ExtendedModelMap
extends ModelMap
implements Model

Subclass of ModelMap that implements the Model interface. Java 5 specific like the Model interface itself.

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,V>, AbstractMap.SimpleImmutableEntry<K,V>
 
Constructor Summary
ExtendedModelMap()
           
 
Method Summary
 ExtendedModelMap addAllAttributes(Collection attributeValues)
          Copy all attributes in the supplied Collection into this Map, using attribute name generation for each element.
 ExtendedModelMap addAllAttributes(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, 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(Map<String,?> attributes)
          Copy all attributes in the supplied Map into this Map, with existing objects of the same name taking precedence (i.e. not getting replaced).
 
Methods inherited from class org.springframework.ui.ModelMap
addAllAttributes, addAllObjects, addAllObjects, addObject, addObject, containsAttribute, mergeAttributes
 
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, get, removeEldestEntry
 
Methods inherited from class java.util.HashMap
clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values
 
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 org.springframework.ui.Model
containsAttribute
 
Methods inherited from interface java.util.Map
containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Constructor Detail

ExtendedModelMap

public ExtendedModelMap()
Method Detail

addAttribute

public ExtendedModelMap addAttribute(String attributeName,
                                     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(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(Map<String,?> attributes)
Description copied from interface: Model
Copy all attributes in the supplied Map into this Map.

Specified by:
addAllAttributes in interface Model
See Also:
Model.addAttribute(String, Object)

mergeAttributes

public ExtendedModelMap mergeAttributes(Map<String,?> attributes)
Description copied from interface: Model
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

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

The Spring Framework

Copyright © 2002-2008 The Spring Framework.