public abstract class DefaultArrayAdapter extends WrappingTemplateModel implements TemplateSequenceModel, AdapterTemplateModel, WrapperTemplateModel, java.io.Serializable
array
of a non-primitive elements to the corresponding TemplateModel
interface(s), most
importantly to TemplateHashModelEx
. If you aren't wrapping an already existing array
, 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 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.
SimpleSequence
,
DefaultListAdapter
,
TemplateSequenceModel
,
Serialized FormNOTHING
Modifier and Type | Method and Description |
---|---|
static DefaultArrayAdapter |
adapt(java.lang.Object array,
ObjectWrapperAndUnwrapper 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.
|
getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
get, size
getWrappedObject
public static DefaultArrayAdapter adapt(java.lang.Object array, ObjectWrapperAndUnwrapper wrapper)
array
- The array to adapt; can't be null
. Must be an array.wrapper
- The ObjectWrapper
used to wrap the items in the array. Has to be
ObjectWrapperAndUnwrapper
because of planned future features.public final 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).