Package freemarker.template
Class DefaultIterableAdapter
java.lang.Object
freemarker.template.WrappingTemplateModel
freemarker.template.DefaultIterableAdapter
- All Implemented Interfaces:
WrapperTemplateModel,AdapterTemplateModel,TemplateCollectionModel,TemplateModel,TemplateModelWithAPISupport,Serializable
public class DefaultIterableAdapter
extends WrappingTemplateModel
implements TemplateCollectionModel, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, Serializable
Adapts an
Iterable to the corresponding TemplateModel interface(s), most importantly to
TemplateCollectionModel. This should only be used if Collection is not implemented by the adapted
object, because then DefaultListAdapter and DefaultNonListCollectionAdapter gives more functionality.
Thread safety: A DefaultIterableAdapter is as thread-safe as the Iterable that it wraps is. Normally
you only have to consider read-only access, as the FreeMarker template language doesn't provide means to call
Iterator modifier methods (though of course, Java methods called from the template can violate this rule).
This adapter is used by DefaultObjectWrapper if its iterableSupport property is true, which is not the default for backward compatibility (so you have to set it
explicitly).
- Since:
- 2.3.25
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from interface freemarker.template.TemplateModel
NOTHING -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultIterableAdapteradapt(Iterable<?> iterable, ObjectWrapperWithAPISupport wrapper)Factory method for creating new adapter instances.getAdaptedObject(Class hint)Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.getAPI()Returns the model that exposes the (Java) API of the value.Retrieves the original object wrapped by this model.iterator()Retrieves a template model iterator that is used to iterate over the elements in this collection.Methods inherited from class freemarker.template.WrappingTemplateModel
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
-
Method Details
-
adapt
public static DefaultIterableAdapter adapt(Iterable<?> iterable, ObjectWrapperWithAPISupport wrapper)Factory method for creating new adapter instances.- Parameters:
iterable- The collection to adapt; can't benull.wrapper- TheObjectWrapperused to wrap the items in the array. Has to beObjectWrapperAndUnwrapperbecause of planned future features.
-
iterator
Description copied from interface:TemplateCollectionModelRetrieves a template model iterator that is used to iterate over the elements in this collection.- Specified by:
iteratorin interfaceTemplateCollectionModel- Throws:
TemplateModelException
-
getWrappedObject
Description copied from interface:WrapperTemplateModelRetrieves the original object wrapped by this model.- Specified by:
getWrappedObjectin interfaceWrapperTemplateModel
-
getAdaptedObject
Description copied from interface:AdapterTemplateModelRetrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.- Specified by:
getAdaptedObjectin interfaceAdapterTemplateModel- Parameters:
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 whenhint.isInstance(underlyingObject)holds. When called withjava.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).- Returns:
- the underlying object, or its value accommodated for the hint class.
-
getAPI
Description copied from interface:TemplateModelWithAPISupportReturns the model that exposes the (Java) API of the value. This is usually implemented by delegating toObjectWrapperWithAPISupport.wrapAsAPI(Object).- Specified by:
getAPIin interfaceTemplateModelWithAPISupport- Throws:
TemplateModelException
-