public interface TemplateHashModelEx extends TemplateHashModel
An extended hash interface with a couple of extra hooks. If a class
implements this interface, then the built-in operators ?size
,
?keys
, and ?values
can be applied to its
instances in the template.
As of version 2.2.2, the engine will automatically wrap the
collections returned by keys
and values
to
present them as sequences to the template. For performance, you may
wish to return objects that implement both TemplateCollectionModel
and TemplateSequenceModel
. Note that the wrapping to sequence happens
on demand; if the template does not try to use the variable returned by
?keys
or ?values
as sequence (theKeys?size
, or theKeys[x]
,
or theKeys?sort
, etc.), just iterates over the variable
(<#list foo?keys as k>...
), then no wrapping to
sequence will happen, thus there will be no overhead.
SimpleHash
NOTHING
Modifier and Type | Method and Description |
---|---|
TemplateCollectionModel |
keys() |
int |
size() |
TemplateCollectionModel |
values() |
get, isEmpty
int size() throws TemplateModelException
TemplateModelException
TemplateCollectionModel keys() throws TemplateModelException
TemplateScalarModel
(as the keys of hashes are always strings).TemplateModelException
TemplateCollectionModel values() throws TemplateModelException
TemplateModelException