Package freemarker.template
Class DefaultMapAdapter
java.lang.Object
freemarker.template.WrappingTemplateModel
freemarker.template.DefaultMapAdapter
- All Implemented Interfaces:
WrapperTemplateModel,AdapterTemplateModel,TemplateHashModel,TemplateHashModelEx,TemplateHashModelEx2,TemplateModel,TemplateModelWithAPISupport,Serializable
public class DefaultMapAdapter
extends WrappingTemplateModel
implements TemplateHashModelEx2, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, Serializable
Adapts a
Map to the corresponding TemplateModel interface(s), most importantly to
TemplateHashModelEx. If you aren't wrapping an already existing Map, but build a hash specifically to
be used from a template, also consider using SimpleHash (see comparison there).
Thread safety: A DefaultMapAdapter is as thread-safe as the Map that it wraps is. Normally you only
have to consider read-only access, as the FreeMarker template language doesn't allow writing these hashes (though of
course, Java methods called from the template can violate this rule).
This adapter is used by DefaultObjectWrapper if its useAdaptersForCollections property is
true, which is the default when its incompatibleImprovements property is 2.3.22 or higher.
- Since:
- 2.3.22
- See Also:
- Serialized Form
-
Nested Class Summary
Nested classes/interfaces inherited from interface freemarker.template.TemplateHashModelEx2
TemplateHashModelEx2.KeyValuePair, TemplateHashModelEx2.KeyValuePairIterator -
Field Summary
Fields inherited from interface freemarker.template.TemplateModel
NOTHING -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultMapAdapteradapt(Map map, ObjectWrapperWithAPISupport wrapper)Factory method for creating new adapter instances.Gets aTemplateModelfrom the hash.getAdaptedObject(Class hint)Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.getAPI()Returns the model that exposes the (Java) API of the value.Retrieves the original object wrapped by this model.booleanisEmpty()keys()intsize()values()Methods inherited from class freemarker.template.WrappingTemplateModel
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
-
Method Details
-
adapt
Factory method for creating new adapter instances.- Parameters:
map- The map to adapt; can't benull.wrapper- TheObjectWrapperused to wrap the items in the array.
-
get
Description copied from interface:TemplateHashModelGets aTemplateModelfrom the hash.- Specified by:
getin interfaceTemplateHashModel- Parameters:
key- The name by which theTemplateModelis identified in the template.- Returns:
- The
TemplateModelreferred to by the key, ornullif not found. - Throws:
TemplateModelException
-
isEmpty
public boolean isEmpty()- Specified by:
isEmptyin interfaceTemplateHashModel
-
size
public int size()- Specified by:
sizein interfaceTemplateHashModelEx- Returns:
- the number of key/value mappings in the hash.
-
keys
- Specified by:
keysin interfaceTemplateHashModelEx- Returns:
- a collection containing the keys in the hash. Every element of
the returned collection must implement the
TemplateScalarModel(as the keys of hashes are always strings).
-
values
- Specified by:
valuesin interfaceTemplateHashModelEx- Returns:
- a collection containing the values in the hash. The elements of the
returned collection can be any kind of
TemplateModel-s.
-
keyValuePairIterator
- Specified by:
keyValuePairIteratorin interfaceTemplateHashModelEx2- Returns:
- The iterator that walks through the key-value pairs in the hash. Not
null.
-
getAdaptedObject
Description copied from interface:AdapterTemplateModelRetrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.- Specified by:
getAdaptedObjectin interfaceAdapterTemplateModel- Parameters:
hint- the desired class of the returned value. An implementation should make reasonable effort to retrieve an object of the requested class, but if that is impossible, it must at least return the underlying object as-is. As a minimal requirement, an implementation must always return the exact underlying object whenhint.isInstance(underlyingObject)holds. When called withjava.lang.Object.class, it should return a generic Java object (i.e. if the model is wrapping a scripting language object that is further wrapping a Java object, the deepest underlying Java object should be returned).- Returns:
- the underlying object, or its value accommodated for the hint class.
-
getWrappedObject
Description copied from interface:WrapperTemplateModelRetrieves the original object wrapped by this model.- Specified by:
getWrappedObjectin interfaceWrapperTemplateModel
-
getAPI
Description copied from interface:TemplateModelWithAPISupportReturns the model that exposes the (Java) API of the value. This is usually implemented by delegating toObjectWrapperWithAPISupport.wrapAsAPI(Object).- Specified by:
getAPIin interfaceTemplateModelWithAPISupport- Throws:
TemplateModelException
-