TemplateProcessor (Apache Brooklyn)

java.lang.Object
- brooklyn.util.text.TemplateProcessor

```
public class TemplateProcessor
extends java.lang.Object
```
A variety of methods to assist in Freemarker template processing, including passing in maps with keys flattened (dot-separated namespace), and accessing ManagementContext brooklyn.properties and Entity, EntityDriver, and Location methods and config.
See #processTemplateContents(String, ManagementContextInternal, Map) for a description of how management access is done.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TemplateProcessor.DotSplittingTemplateModel` A Freemarker `TemplateHashModel` which will correctly handle entries of the form "a.b" in this map, matching against template requests for "${a.b}".

Constructor Summary

Constructors
Constructor and Description

TemplateProcessor()

Constructors
Constructor and Description
`TemplateProcessor()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`processTemplate(java.lang.String templateFileName, EntityDriver driver, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)` Deprecated. since 0.7.0 use `processTemplateFile(String, EntityDriver, Map)`
`static java.lang.String`	`processTemplate(java.lang.String templateFileName, java.util.Map<java.lang.String,? extends java.lang.Object> substitutions)` Deprecated. since 0.7.0 use `processTemplateFile(String, Map)`
`static java.lang.String`	`processTemplateContents(java.lang.String templateContents, EntityDriver driver, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)` Processes template contents according to `EntityAndMapTemplateModel`.
`static java.lang.String`	`processTemplateContents(java.lang.String templateContents, EntityInternal entity, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)` Processes template contents with the given items in scope as per `EntityAndMapTemplateModel`.
`static java.lang.String`	`processTemplateContents(java.lang.String templateContents, ManagementContext managementContext, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)` Processes template contents according to `EntityAndMapTemplateModel`.
`static java.lang.String`	`processTemplateContents(java.lang.String templateContents, java.util.Map<java.lang.String,? extends java.lang.Object> substitutions)` Processes template contents using the given map, passed to freemarker, with dot handling as per `TemplateProcessor.DotSplittingTemplateModel`.
`static java.lang.String`	`processTemplateContents(java.lang.String templateContents, freemarker.template.TemplateHashModel substitutions)` Processes template contents against the given `TemplateHashModel`.
`static java.lang.String`	`processTemplateFile(java.lang.String templateFileName, EntityDriver driver, java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)` Processes template contents according to `EntityAndMapTemplateModel`.
`static java.lang.String`	`processTemplateFile(java.lang.String templateFileName, java.util.Map<java.lang.String,? extends java.lang.Object> substitutions)` As per `processTemplateContents(String, Map)`, but taking a file.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TemplateProcessor
```
public TemplateProcessor()
```

Method Detail

processTemplate

@Deprecated
public static java.lang.String processTemplate(java.lang.String templateFileName,
                                          java.util.Map<java.lang.String,? extends java.lang.Object> substitutions)

Deprecated. since 0.7.0 use processTemplateFile(String, Map)

processTemplateFile

public static java.lang.String processTemplateFile(java.lang.String templateFileName,
                                   java.util.Map<java.lang.String,? extends java.lang.Object> substitutions)

As per processTemplateContents(String, Map), but taking a file.

processTemplate

@Deprecated
public static java.lang.String processTemplate(java.lang.String templateFileName,
                                          EntityDriver driver,
                                          java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)

Deprecated. since 0.7.0 use processTemplateFile(String, EntityDriver, Map)

processTemplateFile

public static java.lang.String processTemplateFile(java.lang.String templateFileName,
                                   EntityDriver driver,
                                   java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)

Processes template contents according to EntityAndMapTemplateModel.

processTemplateContents

public static java.lang.String processTemplateContents(java.lang.String templateContents,
                                       EntityDriver driver,
                                       java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)

Processes template contents according to EntityAndMapTemplateModel.

processTemplateContents

public static java.lang.String processTemplateContents(java.lang.String templateContents,
                                       ManagementContext managementContext,
                                       java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)

Processes template contents according to EntityAndMapTemplateModel.

processTemplateContents

public static java.lang.String processTemplateContents(java.lang.String templateContents,
                                       EntityInternal entity,
                                       java.util.Map<java.lang.String,? extends java.lang.Object> extraSubstitutions)

Processes template contents with the given items in scope as per EntityAndMapTemplateModel.

processTemplateContents

public static java.lang.String processTemplateContents(java.lang.String templateContents,
                                       java.util.Map<java.lang.String,? extends java.lang.Object> substitutions)

Processes template contents using the given map, passed to freemarker, with dot handling as per TemplateProcessor.DotSplittingTemplateModel.

processTemplateContents

public static java.lang.String processTemplateContents(java.lang.String templateContents,
                                       freemarker.template.TemplateHashModel substitutions)

Processes template contents against the given TemplateHashModel.

Class TemplateProcessor

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateProcessor

Method Detail

processTemplate

processTemplateFile

processTemplate

processTemplateFile

processTemplateContents

processTemplateContents

processTemplateContents

processTemplateContents

processTemplateContents