public class DefaultIteratorAdapter extends WrappingTemplateModel implements TemplateCollectionModel, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, Serializable
Iteratorto the corresponding
TemplateModelinterface(s), most importantly to
TemplateCollectionModel. The resulting
TemplateCollectionModelcan 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 its
useAdaptersForCollections property is
true, which is the default when its
incompatibleImprovements property is 2.3.22 or higher.
|Modifier and Type||Method and Description|
Factory method for creating new adapter instances.
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
Returns the model that exposes the (Java) API of the value.
Retrieves the original object wrapped by this model.
Retrieves a template model iterator that is used to iterate over the elements in this collection.
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
public static DefaultIteratorAdapter adapt(Iterator iterator, ObjectWrapper wrapper)
iterator- The iterator to adapt; can't be
public Object getWrappedObject()
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).
public TemplateModelIterator iterator() throws TemplateModelException
public TemplateModel getAPI() throws TemplateModelException