Package freemarker.ext.beans
The default object wrapper of FreeMarker uses this to expose Java Beans and POJO-s to templates.
Most of the issues dealing with beans are handled by the
BeansWrapper.wrap(Object)
and BeansWrapper.getStaticModels()
methods. In normal cases,
these are the only methods
you should use to turn an arbitrary Java object into a
FreeMarker TemplateModel
. Additionally, you can manually create
instance of any wrapper class using its constructors.
Note, however that in such cases you bypass the eventual model caching
of the wrapper.
-
Interface Summary Interface Description ClassMemberAccessPolicy Returned byMemberAccessPolicy.forClass(Class)
.MemberAccessPolicy Implement this to restrict what class members (methods, fields, constructors) are accessible from templates.MethodAppearanceFineTuner Used for customizing how the methods are visible from templates, viaBeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner)
.SingletonCustomizer Marker interface useful when used together withMethodAppearanceFineTuner
and such customizer objects, to indicate that it doesn't contain reference to theObjectWrapper
(so beware with non-static inner classes) and can be and should be used in call introspection cache keys. -
Class Summary Class Description ArrayModel A class that will wrap an arbitrary array intoTemplateCollectionModel
andTemplateSequenceModel
interfaces.BeanModel A class that will wrap an arbitrary object intoTemplateHashModel
interface allowing calls to arbitrary property getters and invocation of accessible methods on the object from a template using the object.foo to access properties and object.bar(arg1, arg2) to invoke methods on it.BeansModelCache BeansWrapper ObjectWrapper
that is able to expose the Java API of arbitrary Java objects.BeansWrapper.MethodAppearanceDecision Used forMethodAppearanceFineTuner.process(freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput, freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision)
to store the results; see there.BeansWrapper.MethodAppearanceDecisionInput Used forMethodAppearanceFineTuner.process(freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput, freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision)
as input parameter; see there.BeansWrapperBuilder Gets/creates aBeansWrapper
singleton instance that's already configured as specified in the properties of this object; this is recommended over using theBeansWrapper
constructors.BeansWrapperConfiguration HoldsBeansWrapper
configuration settings and defines their defaults.BlacklistMemberAccessPolicy Blacklist-based member access policy, that is, members that are matched by the listing will not be accessible, all others will be.BooleanModel A class that will wrap instances ofBoolean
into aTemplateBooleanModel
.CollectionModel A special case ofBeanModel
that can wrap Java collections and that implements theTemplateCollectionModel
in order to be usable in a <#list> block.DateModel Wraps arbitrary subclass ofDate
into a reflective model.DefaultMemberAccessPolicy Member access policy, used to implement default behavior that's mostly compatible with pre-2.3.30 versions, but is somewhat safer; it still can't provide safety in practice, if you allow untrusted users to edit templates! UseWhitelistMemberAccessPolicy
if you need stricter control.EnumerationModel A class that addsTemplateModelIterator
functionality to theEnumeration
interface implementers.HashAdapter IteratorModel A class that addsTemplateModelIterator
functionality to theIterator
interface implementers.LegacyDefaultMemberAccessPolicy Legacy blacklist based member access policy, used only to keep old behavior, as it can't provide meaningful safety.MapModel A special case ofBeanModel
that adds implementation forTemplateMethodModelEx
on map objects that is a shortcut for the Map.get() method.MemberSelectorListMemberAccessPolicy Superclass for member-selector-list-based member access policies, likeWhitelistMemberAccessPolicy
.MemberSelectorListMemberAccessPolicy.MemberSelector A condition that matches some type members.NumberModel Wraps arbitrary subclass ofNumber
into a reflective model.OverloadedMethodsModel Wraps a set of same-name overloaded methods behindTemplateMethodModel
interface, like if it was a single method, chooses among them behind the scenes on call-time based on the argument values.ResourceBundleModel A hash model that wraps a resource bundle.SimpleMapModel Model used byBeansWrapper
when simpleMapWrapper mode is enabled.SimpleMethodModel A class that will wrap a reflected method call into aTemplateMethodModel
interface.StringModel Subclass ofBeanModel
that exposes the return value of theObject.toString()
method through theTemplateScalarModel
interface.WhitelistMemberAccessPolicy Whitelist-based member access policy, that is, only members that are matched by the listing will be exposed. -
Exception Summary Exception Description InvalidPropertyException An exception thrown when there is an attempt to access an invalid bean property when we are in a "strict bean" mode -
Annotation Types Summary Annotation Type Description TemplateAccessible Indicates that the the annotated member can be exposed to templates; if the annotated member will be actually exposed depends on theObjectWrapper
in use, and how that was configured.