public class DefaultListAdapter extends WrappingTemplateModel implements TemplateSequenceModel, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, Serializable
List to the corresponding TemplateModel interface(s), most importantly to
TemplateSequenceModel. If you aren't wrapping an already existing List, but build a sequence
specifically to be used from a template, also consider using SimpleSequence (see comparison there).
Thread safety: A DefaultListAdapter is as thread-safe as the List 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.
SimpleSequence,
DefaultArrayAdapter,
TemplateSequenceModel,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
protected List |
list |
NOTHING| Modifier and Type | Method and Description |
|---|---|
static DefaultListAdapter |
adapt(List list,
RichObjectWrapper wrapper)
Factory method for creating new adapter instances.
|
TemplateModel |
get(int index)
Retrieves the i-th template model in this sequence.
|
Object |
getAdaptedObject(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.
|
Object |
getWrappedObject()
Retrieves the original object wrapped by this model.
|
int |
size() |
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrapprotected final List list
public static DefaultListAdapter adapt(List list, RichObjectWrapper wrapper)
list - The list to adapt; can't be null.wrapper - The ObjectWrapper used to wrap the items in the array.public TemplateModel get(int index) throws TemplateModelException
TemplateSequenceModelget in interface TemplateSequenceModelnull if the index is out of bounds. Note that a
null value is interpreted by FreeMarker as "variable does not exist", and accessing a
missing variables is usually considered as an error in the FreeMarker Template Language, so the usage of
a bad index will not remain hidden, unless the default value for that case was also specified in the
template.TemplateModelExceptionpublic int size()
throws TemplateModelException
size in interface TemplateSequenceModelTemplateModelExceptionpublic Object getAdaptedObject(Class hint)
AdapterTemplateModelgetAdaptedObject in interface AdapterTemplateModelhint - 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 Object getWrappedObject()
WrapperTemplateModelgetWrappedObject in interface WrapperTemplateModelpublic TemplateModel getAPI() throws TemplateModelException
TemplateModelWithAPISupportObjectWrapperWithAPISupport.wrapAsAPI(Object).getAPI in interface TemplateModelWithAPISupportTemplateModelExceptionCopyright © 2020. All Rights Reserved.