Package freemarker.template
Class DefaultIteratorAdapter
- java.lang.Object
-
- freemarker.template.WrappingTemplateModel
-
- freemarker.template.DefaultIteratorAdapter
-
- All Implemented Interfaces:
WrapperTemplateModel
,AdapterTemplateModel
,TemplateCollectionModel
,TemplateModel
,TemplateModelWithAPISupport
,java.io.Serializable
public class DefaultIteratorAdapter extends WrappingTemplateModel implements TemplateCollectionModel, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, java.io.Serializable
Adapts anIterator
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModel
. The resultingTemplateCollectionModel
can only be listed (iterated) once. If the user tries list the variable for a second time, an exception will be thrown instead of silently gettig an empty (or partial) listing.Thread safety: A
DefaultListAdapter
is as thread-safe as the array that it wraps is. Normally you only have to consider read-only access, as the FreeMarker template language doesn't allow writing these sequences (though of course, Java methods called from the template can violate this rule).This adapter is used by
DefaultObjectWrapper
if itsuseAdaptersForCollections
property istrue
, which is the default when itsincompatibleImprovements
property is 2.3.22 or higher.- Since:
- 2.3.22
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface freemarker.template.TemplateModel
NOTHING
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultIteratorAdapter
adapt(java.util.Iterator iterator, ObjectWrapper wrapper)
Factory method for creating new adapter instances.java.lang.Object
getAdaptedObject(java.lang.Class hint)
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.TemplateModel
getAPI()
Returns the model that exposes the (Java) API of the value.java.lang.Object
getWrappedObject()
Retrieves the original object wrapped by this model.TemplateModelIterator
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 Detail
-
adapt
public static DefaultIteratorAdapter adapt(java.util.Iterator iterator, ObjectWrapper wrapper)
Factory method for creating new adapter instances.- Parameters:
iterator
- The iterator to adapt; can't benull
.
-
getWrappedObject
public java.lang.Object getWrappedObject()
Description copied from interface:WrapperTemplateModel
Retrieves the original object wrapped by this model.- Specified by:
getWrappedObject
in interfaceWrapperTemplateModel
-
getAdaptedObject
public java.lang.Object getAdaptedObject(java.lang.Class hint)
Description copied from interface:AdapterTemplateModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.- Specified by:
getAdaptedObject
in 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 when hint.isInstance(underlyingObject) holds. When called with java.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.
-
iterator
public TemplateModelIterator iterator() throws TemplateModelException
Description copied from interface:TemplateCollectionModel
Retrieves a template model iterator that is used to iterate over the elements in this collection.- Specified by:
iterator
in interfaceTemplateCollectionModel
- Throws:
TemplateModelException
-
getAPI
public TemplateModel getAPI() throws TemplateModelException
Description copied from interface:TemplateModelWithAPISupport
Returns the model that exposes the (Java) API of the value. This is usually implemented by delegating toObjectWrapperWithAPISupport.wrapAsAPI(Object)
.- Specified by:
getAPI
in interfaceTemplateModelWithAPISupport
- Throws:
TemplateModelException
-
-