public class DefaultIterableAdapter extends WrappingTemplateModel implements TemplateCollectionModel, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, java.io.Serializable
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).
NOTHING
Modifier and Type | Method and Description |
---|---|
static DefaultIterableAdapter |
adapt(java.lang.Iterable<?> iterable,
ObjectWrapperWithAPISupport 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.
|
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
public static DefaultIterableAdapter adapt(java.lang.Iterable<?> iterable, ObjectWrapperWithAPISupport wrapper)
iterable
- The collection to adapt; can't be null
.wrapper
- The ObjectWrapper
used to wrap the items in the array. Has to be
ObjectWrapperAndUnwrapper
because of planned future features.public TemplateModelIterator iterator() throws TemplateModelException
TemplateCollectionModel
iterator
in interface TemplateCollectionModel
TemplateModelException
public java.lang.Object getWrappedObject()
WrapperTemplateModel
getWrappedObject
in interface WrapperTemplateModel
public java.lang.Object getAdaptedObject(java.lang.Class hint)
AdapterTemplateModel
getAdaptedObject
in interface AdapterTemplateModel
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 TemplateModel getAPI() throws TemplateModelException
TemplateModelWithAPISupport
ObjectWrapperWithAPISupport.wrapAsAPI(Object)
.getAPI
in interface TemplateModelWithAPISupport
TemplateModelException