com.atlassian.bamboo.template

Interface TemplateRenderer

All Known Implementing Classes:

BambooFreemarkerManager

public interface TemplateRenderer

Interface to render a template into the output

Method Summary

Modifier and Type	Method and Description
String	render(String templatePath, Map<String,Object> contextParams)
void	render(String templatePath, Map<String,Object> contextParams, Writer writer) Render the given template to the given writer
String	renderText(String text, Map<String,Object> contextParams)
String	renderWithoutActionContext(String templatePath, Map<String,Object> contextParams)

Method Detail

render

@Nullable
String render(@Nullable
                        String templatePath,
                        Map<String,Object> contextParams)

renderWithoutActionContext

@NotNull
String renderWithoutActionContext(@Nullable
                                           String templatePath,
                                           @NotNull
                                           Map<String,Object> contextParams)

renderText

@NotNull
String renderText(@NotNull
                           String text,
                           @Nullable
                           Map<String,Object> contextParams)

render

void render(@Nullable
            String templatePath,
            @Nullable
            Map<String,Object> contextParams,
            @NotNull
            Writer writer)
     throws IOException

Render the given template to the given writer

Parameters:

templatePath - The path of the template

contextParams - The template context params

writer - The writer to write to

Throws:

IOException - If an error occurred while writing to the writer