public class DefaultMapAdapter extends WrappingTemplateModel implements TemplateHashModelEx2, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, java.io.Serializable
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.
TemplateHashModelEx2.KeyValuePair, TemplateHashModelEx2.KeyValuePairIterator
NOTHING
Modifier and Type | Method and Description |
---|---|
static DefaultMapAdapter |
adapt(java.util.Map map,
ObjectWrapperWithAPISupport wrapper)
Factory method for creating new adapter instances.
|
TemplateModel |
get(java.lang.String key)
Gets a TemplateModel from the hash.
|
java.lang.Object |
getAdaptedObject(java.lang.Class hint)
Retrieves the underlying object, or some other object semantically
equivalent to its value narrowed by the class hint.
|
TemplateModel |
getAPI()
Returns the model that exposes the (Java) API of the value.
|
java.lang.Object |
getWrappedObject()
Retrieves the original object wrapped by this model.
|
boolean |
isEmpty() |
TemplateCollectionModel |
keys() |
TemplateHashModelEx2.KeyValuePairIterator |
keyValuePairIterator() |
int |
size() |
TemplateCollectionModel |
values() |
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
public static DefaultMapAdapter adapt(java.util.Map map, ObjectWrapperWithAPISupport wrapper)
map
- The map to adapt; can't be null
.wrapper
- The ObjectWrapper
used to wrap the items in the array.public TemplateModel get(java.lang.String key) throws TemplateModelException
TemplateHashModel
get
in interface TemplateHashModel
key
- the name by which the TemplateModel
is identified in the template.TemplateModelException
public boolean isEmpty()
isEmpty
in interface TemplateHashModel
public int size()
size
in interface TemplateHashModelEx
public TemplateCollectionModel keys()
keys
in interface TemplateHashModelEx
TemplateScalarModel
(as the keys of hashes are always strings).public TemplateCollectionModel values()
values
in interface TemplateHashModelEx
TemplateModel
-s.public TemplateHashModelEx2.KeyValuePairIterator keyValuePairIterator()
keyValuePairIterator
in interface TemplateHashModelEx2
null
.public java.lang.Object getAdaptedObject(java.lang.Class hint)
AdapterTemplateModel
getAdaptedObject
in interface AdapterTemplateModel
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 when
hint.isInstance(underlyingObject) holds. When called
with java.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).public java.lang.Object getWrappedObject()
WrapperTemplateModel
getWrappedObject
in interface WrapperTemplateModel
public TemplateModel getAPI() throws TemplateModelException
TemplateModelWithAPISupport
ObjectWrapperWithAPISupport.wrapAsAPI(Object)
.getAPI
in interface TemplateModelWithAPISupport
TemplateModelException