com.metaboss.sdlctools.services.jdktools
Interface BSJamonTemplateProcessor

public interface BSJamonTemplateProcessor

This component provides Jamon template processing service. Jamon is an Open Source text template engine for Java. See Jamon Web Site for more information on Jamon.

Field Summary

static java.lang.String

COMPONENT_URL Naming URL of the component

Method Summary

MergeResult

mergeTemplate(java.lang.String pSourceTemplate, java.lang.String pSourceTemplateName, java.util.Map pContextMap) Merges given template with given set of properties.

Field Detail

COMPONENT_URL

public static final java.lang.String COMPONENT_URL

Naming URL of the component

See Also:

Constant Field Values

Method Detail

mergeTemplate

public MergeResult mergeTemplate(java.lang.String pSourceTemplate,
                                 java.lang.String pSourceTemplateName,
                                 java.util.Map pContextMap)
                          throws BSException

Merges given template with given set of properties.

Parameters:

pSourceTemplate - the buffer with template text in it. Note that the template source must not use <%args> construct to specify arguments. This is because the template argument specification is fixed and constructed automatically as follows: <%args> com.metaboss.javatemplate.JavaTemplateContext pContext; </%args> This is done to keep Jamon templates in line with other types of templates (Java and Velocity).

pSourceTemplateName - the unique name of the template - used in logging, may also be used in caching, so the caller must make sure that the same template always has exact same name. Name can be supplied with java style package separators (e.g. metaboss.generation.CodeTemplate)

pContextMap - the context map to pass to the template processor. This context map will be supplied to the Jamon template as com.metaboss.javatemplate.JavaTemplateContext pContext argument.

Returns:

MergeResult contains the result of the requested operation

Throws:

BSException