{title:'Templated Swaps'}

The {@link oaj.annotation.Swap#template() @Swap(template)} annotation allows you to associate arbitrary contextual strings with swaps. The primary purpose is for providing template names, such as for Apache FreeMarker, therefore the name 'template'. However, the usage of the string is open-ended.

For example, you could pair a template string like so:

| @Swap(impl=FreeMarkerSwap.class, template="MyPojo.div.ftl") | public class MyPojo {}

The implementation of the FreeMarker swap would look something like this:

| // Our templated swap class. | public class FreeMarkerSwap extends ObjectSwap<Object,Reader> { | | public MediaType[] forMediaTypes() { | // Make sure this only applies to the HTML serializer. | return MediaType.forStrings("*/html"); | } | | public Reader swap(BeanSession session, Object object, String template) throws Exception { | // Call some method that uses FreeMarker to convert 'o' to raw HTML using | // the 'MyPojo.div.ftl' template. | return getFreeMarkerReader(template, object); | } | }