public interface Model
Primarily designed for adding attributes to the model.
Allows for accessing the overall model as a java.util.Map
.
Modifier and Type | Method and Description |
---|---|
Model |
addAllAttributes(Collection<?> attributeValues)
Copy all attributes in the supplied
Collection into this
Map , using attribute name generation for each element. |
Model |
addAllAttributes(Map<String,?> attributes)
Copy all attributes in the supplied
Map into this Map . |
Model |
addAttribute(Object attributeValue)
Add the supplied attribute to this
Map using a
generated name . |
Model |
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.
|
boolean |
containsAttribute(String attributeName)
Does this model contain an attribute of the given name?
|
Object |
getAttribute(String attributeName)
Return the attribute value for the given name, if any.
|
Model |
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. |
Model addAttribute(String attributeName, @Nullable Object attributeValue)
attributeName
- the name of the model attribute (never null
)attributeValue
- the model attribute value (can be null
)Model addAttribute(Object attributeValue)
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.
attributeValue
- the model attribute value (never null
)Model addAllAttributes(Collection<?> attributeValues)
Collection
into this
Map
, using attribute name generation for each element.addAttribute(Object)
Model addAllAttributes(Map<String,?> attributes)
Map
into this Map
.addAttribute(String, Object)
Model mergeAttributes(Map<String,?> attributes)
Map
into this Map
,
with existing objects of the same name taking precedence (i.e. not getting
replaced).boolean containsAttribute(String attributeName)
attributeName
- the name of the model attribute (never null
)@Nullable Object getAttribute(String attributeName)
attributeName
- the name of the model attribute (never null
)null
if none