freemarker.template

Class DefaultObjectWrapper

java.lang.Object

freemarker.ext.beans.BeansWrapper

freemarker.template.DefaultObjectWrapper

All Implemented Interfaces:

ObjectWrapper

Direct Known Subclasses:

SimpleObjectWrapper

public class DefaultObjectWrapper
extends BeansWrapper

The default implementation of the ObjectWrapper interface.

Nested Class Summary

Nested classes/interfaces inherited from class freemarker.ext.beans.BeansWrapper

BeansWrapper.MethodAppearanceDecision

Field Summary

Fields inherited from class freemarker.ext.beans.BeansWrapper

EXPOSE_ALL, EXPOSE_NOTHING, EXPOSE_PROPERTIES_ONLY, EXPOSE_SAFE

Fields inherited from interface freemarker.template.ObjectWrapper

BEANS_WRAPPER, DEFAULT_WRAPPER, SIMPLE_WRAPPER

Constructor Summary

Constructors

Constructor and Description
DefaultObjectWrapper()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	convertArray(java.lang.Object arr) Converts an array to a java.util.List
protected TemplateModel	handleUnknownType(java.lang.Object obj) Called if an unknown type is passed in.
TemplateModel	wrap(java.lang.Object obj) Wraps the object with a template model that is most specific for the object's class.
TemplateModel	wrapDomNode(java.lang.Object obj)

Methods inherited from class freemarker.ext.beans.BeansWrapper

clearClassIntrospecitonCache, coerceBigDecimal, coerceBigDecimals, coerceBigDecimals, finetuneMethodAppearance, getDefaultDateType, getDefaultInstance, getEnumModels, getInstance, getModelFactory, getOuterIdentity, getStaticModels, isExposeFields, isSimpleMapWrapper, isStrict, newInstance, removeFromClassIntrospectionCache, setDefaultDateType, setExposeFields, setExposureLevel, setMethodsShadowItems, setNullModel, setOuterIdentity, setSimpleMapWrapper, setStrict, setUseCache, unwrap, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultObjectWrapper

public DefaultObjectWrapper()

Method Detail

wrap

public TemplateModel wrap(java.lang.Object obj)
                   throws TemplateModelException

Description copied from class: BeansWrapper

Wraps the object with a template model that is most specific for the object's class. Specifically:

• if the object is null, returns the null model,
• if the object is a Number returns a NumberModel for it,
• if the object is a Date returns a DateModel for it,
• if the object is a Boolean returns TemplateBooleanModel.TRUE or TemplateBooleanModel.FALSE
• if the object is already a TemplateModel, returns it unchanged,
• if the object is an array, returns a ArrayModel for it
• if the object is a Map, returns a MapModel for it
• if the object is a Collection, returns a CollectionModel for it
• if the object is an Iterator, returns a IteratorModel for it
• if the object is an Enumeration, returns a EnumerationModel for it
• if the object is a String, returns a StringModel for it
• otherwise, returns a generic BeanModel for it.

Specified by:

wrap in interface ObjectWrapper

Overrides:

wrap in class BeansWrapper

Parameters:

obj - The object to wrap into a TemplateModel. If the it already implements TemplateModel, it should just return the object as is.

Returns:

a TemplateModel wrapper of the object passed in. To support un-wrapping, you may consider the return value to implement WrapperTemplateModel and AdapterTemplateModel.

Throws:

TemplateModelException

handleUnknownType

protected TemplateModel handleUnknownType(java.lang.Object obj)
                                   throws TemplateModelException

Called if an unknown type is passed in. Since 2.3, this falls back on XML wrapper and BeansWrapper functionality.

Throws:

TemplateModelException

wrapDomNode

public TemplateModel wrapDomNode(java.lang.Object obj)

convertArray

protected java.lang.Object convertArray(java.lang.Object arr)

Converts an array to a java.util.List