Package freemarker.template
Class DefaultNonListCollectionAdapter
java.lang.Object
freemarker.template.WrappingTemplateModel
freemarker.template.DefaultNonListCollectionAdapter
- All Implemented Interfaces:
WrapperTemplateModel,AdapterTemplateModel,TemplateCollectionModel,TemplateCollectionModelEx,TemplateModel,TemplateModelWithAPISupport,Serializable
public class DefaultNonListCollectionAdapter
extends WrappingTemplateModel
implements TemplateCollectionModelEx, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, Serializable
Adapts a non-
List Java Collection to the corresponding TemplateModel interface(s), most
importantly to TemplateCollectionModelEx. For List-s, use DefaultListAdapter, or else you
lose indexed element access.
Thread safety: A DefaultNonListCollectionAdapter is as thread-safe as the Collection that it wraps
is. Normally you only have to consider read-only access, as the FreeMarker template language doesn't allow writing
these collections (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, and its
forceLegacyNonListCollections property is
false, which is still not the default as of 2.3.22 (so you have to set it explicitly).
- Since:
- 2.3.22
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from interface freemarker.template.TemplateModel
NOTHING -
Method Summary
Modifier and TypeMethodDescriptionadapt(Collection collection, ObjectWrapperWithAPISupport wrapper)Factory method for creating new adapter instances.booleancontains(TemplateModel item)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.booleanisEmpty()Returns if the collection contains any elements.iterator()Retrieves a template model iterator that is used to iterate over the elements in this collection.intsize()Returns the number items in this collection, orInteger.MAX_VALUE, if there are more thanInteger.MAX_VALUEitems.Methods inherited from class freemarker.template.WrappingTemplateModel
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
-
Method Details
-
adapt
public static DefaultNonListCollectionAdapter adapt(Collection collection, ObjectWrapperWithAPISupport wrapper)Factory method for creating new adapter instances.- Parameters:
collection- The collection to adapt; can't benull.wrapper- TheObjectWrapperused to wrap the items in the collection. 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
-
size
public int size()Description copied from interface:TemplateCollectionModelExReturns the number items in this collection, orInteger.MAX_VALUE, if there are more thanInteger.MAX_VALUEitems.- Specified by:
sizein interfaceTemplateCollectionModelEx
-
isEmpty
public boolean isEmpty()Description copied from interface:TemplateCollectionModelExReturns if the collection contains any elements. This differs fromsize() != 0only in that the exact number of items need not be calculated.- Specified by:
isEmptyin interfaceTemplateCollectionModelEx
-
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.
-
contains
- Throws:
TemplateModelException
-
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
-