public class DefaultNonListCollectionAdapter extends WrappingTemplateModel implements TemplateCollectionModelEx, AdapterTemplateModel, WrapperTemplateModel, TemplateModelWithAPISupport, Serializable
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).
Experimental status warning: This class is subject to change on non-backward compatible ways, hence, it shouldn't be used from outside FreeMarker yet.
NOTHING| Modifier and Type | Method and Description |
|---|---|
static DefaultNonListCollectionAdapter |
adapt(Collection collection,
ObjectWrapperWithAPISupport wrapper)
Factory method for creating new adapter instances.
|
boolean |
contains(TemplateModel item)
Tells if a given value occurs in the collection, accodring the rules of the wrapped collection.
|
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.
|
boolean |
isEmpty()
Returns if the collection contains any elements.
|
TemplateModelIterator |
iterator()
Retrieves a template model iterator that is used to iterate over the elements in this collection.
|
int |
size()
Returns the number items in this collection, or
Integer.MAX_VALUE, if there are more than
Integer.MAX_VALUE items. |
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrappublic static DefaultNonListCollectionAdapter adapt(Collection collection, ObjectWrapperWithAPISupport wrapper)
collection - 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
TemplateCollectionModeliterator in interface TemplateCollectionModelTemplateModelExceptionpublic int size()
TemplateCollectionModelExInteger.MAX_VALUE, if there are more than
Integer.MAX_VALUE items.size in interface TemplateCollectionModelExpublic boolean isEmpty()
TemplateCollectionModelExsize() != 0 only in that the exact
number of items need not be calculated.isEmpty in interface TemplateCollectionModelExpublic Object getWrappedObject()
WrapperTemplateModelgetWrappedObject in interface WrapperTemplateModelpublic 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 boolean contains(TemplateModel item) throws TemplateModelException
TemplateCollectionModelEx?seq_contains(e).contains in interface TemplateCollectionModelExTemplateModelExceptionpublic TemplateModel getAPI() throws TemplateModelException
TemplateModelWithAPISupportObjectWrapperWithAPISupport.wrapAsAPI(Object).getAPI in interface TemplateModelWithAPISupportTemplateModelExceptionCopyright © 2020. All Rights Reserved.