public class DefaultObjectWrapper extends BeansWrapper
ObjectWrapper
interface. Usually, you don't need to create instances of
this, as an instance of this is already the default value of the
object_wrapper setting
. Then the
incompatibleImprovements
of the DefaultObjectWrapper
will be the same
that you have set for the Configuration
itself. As of this writing, it's highly recommended to use
incompatibleImprovements
2.3.22 (or higher).
If you still need to create an instance, that should be done with an DefaultObjectWrapperBuilder
, not with
its constructor, as that allows FreeMarker to reuse singletons. For new projects, it's recommended to set
forceLegacyNonListCollections
to
false
- something that setting incompatibleImprovements
to 2.3.22 won't do.
This class is only thread-safe after you have finished calling its setter methods, and then safely published it (see
JSR 133 and related literature). When used as part of Configuration
, of course it's enough if that was safely
published and then left unmodified.
BeansWrapper.MethodAppearanceDecision, BeansWrapper.MethodAppearanceDecisionInput
EXPOSE_ALL, EXPOSE_NOTHING, EXPOSE_PROPERTIES_ONLY, EXPOSE_SAFE
CANT_UNWRAP_TO_TARGET_CLASS
BEANS_WRAPPER, DEFAULT_WRAPPER, SIMPLE_WRAPPER
Modifier | Constructor and Description |
---|---|
|
DefaultObjectWrapper()
Deprecated.
Use
DefaultObjectWrapperBuilder , or in rare cases,
DefaultObjectWrapper(Version) instead. |
protected |
DefaultObjectWrapper(BeansWrapperConfiguration bwCfg,
boolean writeProtected)
Use
DefaultObjectWrapper(DefaultObjectWrapperConfiguration, boolean) instead if possible;
it does the same, except that it tolerates a non-DefaultObjectWrapperConfiguration configuration too. |
protected |
DefaultObjectWrapper(DefaultObjectWrapperConfiguration dowCfg,
boolean writeProtected)
Calls
BeansWrapper.BeansWrapper(BeansWrapperConfiguration, boolean) and sets up
DefaultObjectWrapper -specific fields. |
|
DefaultObjectWrapper(Version incompatibleImprovements)
Use
DefaultObjectWrapperBuilder instead if possible. |
Modifier and Type | Method and Description |
---|---|
protected Object |
convertArray(Object arr)
Converts an array to a java.util.List.
|
boolean |
getForceLegacyNonListCollections()
Getter pair of
setForceLegacyNonListCollections(boolean) ; see there. |
boolean |
getUseAdaptersForContainers()
The getter pair of
setUseAdaptersForContainers(boolean) . |
protected TemplateModel |
handleUnknownType(Object obj)
Called for an object that aren't considered to be of a "basic" Java type, like for an application specific type,
or for a W3C DOM node.
|
protected static Version |
normalizeIncompatibleImprovementsVersion(Version incompatibleImprovements)
Returns the lowest version number that is equivalent with the parameter version.
|
void |
setForceLegacyNonListCollections(boolean forceLegacyNonListCollections)
Specifies whether non-
List Collection -s (like Set -s) must be wrapped by pre-fetching into
a SimpleSequence . |
void |
setUseAdaptersForContainers(boolean useAdaptersForContainers)
|
protected String |
toPropertiesString()
Returns the name-value pairs that describe the configuration of this
BeansWrapper ; called from
BeansWrapper.toString() . |
TemplateModel |
wrap(Object obj)
Wraps the parameter object to
TemplateModel interface(s). |
TemplateModel |
wrapDomNode(Object obj) |
checkModifiable, clearClassIntrospecitonCache, coerceBigDecimal, coerceBigDecimals, coerceBigDecimals, finalizeConstruction, finetuneMethodAppearance, getDefaultDateType, getDefaultInstance, getEnumModels, getExposureLevel, getIncompatibleImprovements, getInstance, getMethodAppearanceFineTuner, getModelFactory, getOuterIdentity, getStaticModels, getUseCache, isClassIntrospectionCacheRestricted, isExposeFields, isSimpleMapWrapper, isStrict, isWriteProtected, newInstance, removeFromClassIntrospectionCache, setDefaultDateType, setExposeFields, setExposureLevel, setMethodAppearanceFineTuner, setMethodsShadowItems, setNullModel, setOuterIdentity, setSimpleMapWrapper, setStrict, setUseCache, toString, tryUnwrapTo, unwrap, unwrap, wrap, wrapAsAPI, writeProtect
public DefaultObjectWrapper()
DefaultObjectWrapperBuilder
, or in rare cases,
DefaultObjectWrapper(Version)
instead.Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS
.public DefaultObjectWrapper(Version incompatibleImprovements)
DefaultObjectWrapperBuilder
instead if possible. Instances created with this constructor won't share
the class introspection caches with other instances. See BeansWrapper.BeansWrapper(Version)
(the
superclass constructor) for more details.incompatibleImprovements
- It's the same as in BeansWrapper.BeansWrapper(Version)
, plus these changes:
useAdaptersForContainers
changes to
true
.protected DefaultObjectWrapper(BeansWrapperConfiguration bwCfg, boolean writeProtected)
DefaultObjectWrapper(DefaultObjectWrapperConfiguration, boolean)
instead if possible;
it does the same, except that it tolerates a non-DefaultObjectWrapperConfiguration
configuration too.protected DefaultObjectWrapper(DefaultObjectWrapperConfiguration dowCfg, boolean writeProtected)
BeansWrapper.BeansWrapper(BeansWrapperConfiguration, boolean)
and sets up
DefaultObjectWrapper
-specific fields.public TemplateModel wrap(Object obj) throws TemplateModelException
TemplateModel
interface(s). Simple types like numbers, strings, booleans
and dates will be wrapped into the corresponding SimpleXxx
classes (like SimpleNumber
).
Map
-s, List
-s, other Collection
-s, arrays and Iterator
-s will be wrapped into the
corresponding SimpleXxx
or DefaultXxxAdapter
classes (like SimpleHash
or
DefaultMapAdapter
), depending on getUseAdaptersForContainers()
and
getForceLegacyNonListCollections()
. After that, the wrapping is handled by
handleUnknownType(Object)
, so see more there.wrap
in interface ObjectWrapper
wrap
in class BeansWrapper
obj
- The object to wrap into a TemplateModel
. If it already implements TemplateModel
,
it should just return the object as is. If it's null
, the method should return null
(however, BeansWrapper
, has a legacy option for returning a null model object instead, but it's not
a good idea).TemplateModel
wrapper of the object passed in. To support un-wrapping, you may consider the
return value to implement WrapperTemplateModel
and AdapterTemplateModel
.
The default expectation is that the TemplateModel
isn't less thread safe than the wrapped object.
If the ObjectWrapper
returns less thread safe objects, that should be clearly documented, as it
restricts how it can be used, like, then it can't be used to wrap "shared variables"
(Configuration.setSharedVaribles(Map)
).TemplateModelException
protected TemplateModel handleUnknownType(Object obj) throws TemplateModelException
Node
-s will be wrapped as NodeModel
-s
(allows DOM tree traversal), Jython objects will be delegated to the JythonWrapper
, others will be
wrapped using BeansWrapper.wrap(Object)
.
When you override this method, you should first decide if you want to wrap the object in a custom way (and if so then do it and return with the result), and if not, then you should call the super method (assuming the default behavior is fine with you).
TemplateModelException
public TemplateModel wrapDomNode(Object obj)
public boolean getUseAdaptersForContainers()
setUseAdaptersForContainers(boolean)
.public void setUseAdaptersForContainers(boolean useAdaptersForContainers)
Map
-s, List
-s, arrays and such) the legacy copying approach or
the newer adapter approach should be used. true
is recommended, which is also the default when the
incompatible_improvements
of this instance was set to Configuration.VERSION_2_3_22
or higher. To
understand the difference, check some of the classes that implement the two approaches:
SimpleHash
, SimpleSequence
DefaultMapAdapter
, DefaultListAdapter
, DefaultArrayAdapter
,
DefaultIteratorAdapter
See also the related Version History entry under 2.3.22 in the FreeMarker Manual, which gives a breakdown of the consequences.
Attention: For backward compatibility, currently, non-List
collections (like Set
-s) will
only be wrapped with adapter approach (with DefaultNonListCollectionAdapter
) if
forceLegacyNonListCollections
was set to false
.
Currently the default is true
, but in new projects you should set it to false
. See
setForceLegacyNonListCollections(boolean)
for more.
setForceLegacyNonListCollections(boolean)
public boolean getForceLegacyNonListCollections()
setForceLegacyNonListCollections(boolean)
; see there.public void setForceLegacyNonListCollections(boolean forceLegacyNonListCollections)
List
Collection
-s (like Set
-s) must be wrapped by pre-fetching into
a SimpleSequence
. The modern approach is wrapping into a DefaultNonListCollectionAdapter
. This
setting only has effect when getUseAdaptersForContainers()
is also true
, as otherwise
SimpleSequence
will be used regardless of this. In new projects you should set this to false
. At
least before incompatible_improvements
2.4.0 it defaults to true
, because of backward
compatibility concerns: with TemplateSequenceModel
templates could access the items by index if they
wanted to (the index values were defined by the iteration order). This was not very useful, or was even
confusing, and it conflicts with the adapter approach.setUseAdaptersForContainers(boolean)
protected static Version normalizeIncompatibleImprovementsVersion(Version incompatibleImprovements)
protected String toPropertiesString()
BeansWrapper
BeansWrapper
; called from
BeansWrapper.toString()
. The expected format is like "foo=bar, baaz=wombat"
. When overriding this, you should
call the super method, and then insert the content before it with a following ", "
, or after it with a
preceding ", "
.toPropertiesString
in class BeansWrapper