TemplateModelWithAPISupport (FreeMarker 2.3.35 API)
Description: declaration: package: freemarker.template, interface: TemplateModelWithAPISupport

Package freemarker.template

# Interface TemplateModelWithAPISupport

All Superinterfaces:
  `TemplateModel`

All Known Implementing Classes:
  `ArrayModel`, `BeanModel`, `BooleanModel`, `CollectionModel`, `DateModel`, `DefaultEnumerationAdapter`, `DefaultIterableAdapter`, `DefaultIteratorAdapter`, `DefaultListAdapter`, `DefaultMapAdapter`, `DefaultNonListCollectionAdapter`, `EnumerationModel`, `GenericObjectModel`, `IteratorModel`, `MapModel`, `NumberModel`, `ResourceBundleModel`, `SimpleMapModel`, `StringModel`

public interface TemplateModelWithAPISupport extends TemplateModel
A `TemplateModel` on which the `?api` operation can be applied.

Since:
  2.3.22

- ## Field Summary

  ### Fields inherited from interface freemarker.template.TemplateModel

  `NOTHING`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `TemplateModel`
  `getAPI()`
  Returns the model that exposes the (Java) API of the value.

- ## Method Details

  - ### getAPI

    TemplateModel getAPI() throws TemplateModelException
    Returns the model that exposes the (Java) API of the value. This is usually implemented by delegating to `ObjectWrapperWithAPISupport.wrapAsAPI(Object)`.
    Throws:
      `TemplateModelException`