com.sun.jersey.freemarker

Class FreemarkerViewProcessor

java.lang.Object

com.sun.jersey.freemarker.FreemarkerViewProcessor

All Implemented Interfaces:

ViewProcessor<String>

public class FreemarkerViewProcessor
extends Object
implements ViewProcessor<String>

Author:

pavel.bucek@oracle.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	FREEMARKER_TEMPLATES_BASE_PATH Freemarker templates base path.

Constructor Summary

Constructors

Constructor and Description
FreemarkerViewProcessor(ResourceConfig resourceConfig)

Method Summary

Methods

Modifier and Type	Method and Description
String	resolve(String path) Resolve a template name to a template reference.
void	writeTo(String resolvedPath, Viewable viewable, OutputStream out) Process a template and write the result to an output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FREEMARKER_TEMPLATES_BASE_PATH

public static final String FREEMARKER_TEMPLATES_BASE_PATH

Freemarker templates base path. Mandatory parameter, it has to be set if you plan to use freemarker to generate your views.

See Also:

Constant Field Values

Constructor Detail

FreemarkerViewProcessor

public FreemarkerViewProcessor(@Context
                       ResourceConfig resourceConfig)

Method Detail

resolve

public String resolve(String path)

Description copied from interface: ViewProcessor

Resolve a template name to a template reference.

Specified by:

resolve in interface ViewProcessor<String>

Parameters:

path - the template name

Returns:

the template reference, otherwise null if the template name cannot be resolved.

writeTo

public void writeTo(String resolvedPath,
           Viewable viewable,
           OutputStream out)
             throws IOException

Description copied from interface: ViewProcessor

Process a template and write the result to an output stream.

Specified by:

writeTo in interface ViewProcessor<String>

Parameters:

resolvedPath - the template reference. This is obtained by calling the ViewProcessor.resolve(java.lang.String) method with a template name.

viewable - the viewable that contains the model to be passed to the template.

out - the output stream to write the result of processing the template.

Throws:

IOException - if there was an error processing the template.