com.atlassian.fisheye.plugin.web.helpers

Interface VelocityHelper

public interface VelocityHelper

Method Summary

Modifier and Type	Method and Description
java.lang.String	renderVelocityFragment(java.lang.String fragment, java.util.Map<java.lang.String,java.lang.Object> params)
void	renderVelocityTemplate(java.io.InputStream velocityStream, java.util.Map<java.lang.String,java.lang.Object> params, java.io.Writer writer)
void	renderVelocityTemplate(java.lang.String template, java.util.Map<java.lang.String,java.lang.Object> params, java.io.Writer writer)

Method Detail

renderVelocityFragment

java.lang.String renderVelocityFragment(java.lang.String fragment,
                                        java.util.Map<java.lang.String,java.lang.Object> params)

Parameters:

fragment - a velocity fragment

params - a map of parameters to be used as the velocity render context

Returns:

the rendered text

renderVelocityTemplate

void renderVelocityTemplate(java.lang.String template,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            java.io.Writer writer)
                     throws java.io.IOException

Parameters:

template - full path to a velocity template

params - a map of parameters to be used as the velocity render context

writer - the Writer that the rendered text will be written to

Throws:

java.io.IOException - if there was a problem writing to the supplied Writer

renderVelocityTemplate

void renderVelocityTemplate(java.io.InputStream velocityStream,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            java.io.Writer writer)
                     throws java.io.IOException

Parameters:

velocityStream - input stream over a velocity template

params - a map of parameters to be used as the velocity render context

writer - the Writer that the rendered text will be written to

Throws:

java.io.IOException - if there was a problem writing to the supplied Writer