com.atlassian.bamboo.template
Interface TemplateRenderer

All Known Implementing Classes:

BambooFreemarkerManager

public interface TemplateRenderer

Interface to render a template into the output

Method Summary

java.lang.String	render(java.lang.String templatePath, java.util.Map<java.lang.String,java.lang.Object> contextParams)
void	render(java.lang.String templatePath, java.util.Map<java.lang.String,java.lang.Object> contextParams, java.io.Writer writer) Render the given template to the given writer
java.lang.String	renderText(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> contextParams)
java.lang.String	renderWithoutActionContext(java.lang.String templatePath, java.util.Map<java.lang.String,java.lang.Object> contextParams)

Method Detail

render

@Nullable
java.lang.String render(@Nullable
                                 java.lang.String templatePath,
                                 java.util.Map<java.lang.String,java.lang.Object> contextParams)

renderWithoutActionContext

@NotNull
java.lang.String renderWithoutActionContext(@Nullable
                                                    java.lang.String templatePath,
                                                    @NotNull
                                                    java.util.Map<java.lang.String,java.lang.Object> contextParams)

renderText

@NotNull
java.lang.String renderText(@NotNull
                                    java.lang.String text,
                                    @Nullable
                                    java.util.Map<java.lang.String,java.lang.Object> contextParams)

render

void render(@Nullable
            java.lang.String templatePath,
            @Nullable
            java.util.Map<java.lang.String,java.lang.Object> contextParams,
            @NotNull
            java.io.Writer writer)
            throws java.io.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:

java.io.IOException - If an error occured while writing to the writer