org.jamon.compiler
Class TemplateInspector

java.lang.Object
  org.jamon.compiler.TemplateInspector

public class TemplateInspector
extends java.lang.Object

An TemplateInspector manages the reflective rendering of a template, given a template path and a Map of argument values as Strings. This class could certainly use some refactoring, and in fact, the public contract ought to allow reuse for multiple templates.

Nested Class Summary

static class	TemplateInspector.InvalidTemplateException
static class	TemplateInspector.UnknownArgumentsException

Constructor Summary

TemplateInspector(java.lang.String p_templateName)
Construct an TemplateInspector for a template path using the default TemplateManager as determined via the TemplateManagerSource.

TemplateInspector(org.jamon.TemplateManager p_manager, java.lang.String p_templateName)
Construct an TemplateInspector with a template manager, template path.

Method Summary

java.lang.Class<?>	getArgumentType(java.lang.String p_argName)
java.util.List<java.lang.String>	getOptionalArgumentNames()
java.util.List<java.lang.String>	getRequiredArgumentNames()
void	render(java.io.Writer p_writer, java.util.Map<java.lang.String,java.lang.Object> p_argMap) Render the template.
void	render(java.io.Writer p_writer, java.util.Map<java.lang.String,java.lang.Object> p_argMap, boolean p_ignoreUnusedParams) Render the template.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateInspector

public TemplateInspector(java.lang.String p_templateName)
                  throws TemplateInspector.InvalidTemplateException

Construct an TemplateInspector for a template path using the default TemplateManager as determined via the TemplateManagerSource.

Parameters:

p_templateName - the path of the template to be rendered

Throws:

TemplateInspector.InvalidTemplateException

TemplateInspector

public TemplateInspector(org.jamon.TemplateManager p_manager,
                         java.lang.String p_templateName)
                  throws TemplateInspector.InvalidTemplateException

Construct an TemplateInspector with a template manager, template path.

Parameters:

p_manager - the TemplateManager to use

p_templateName - the path of the template to be rendered

Throws:

TemplateInspector.InvalidTemplateException

Method Detail

render

public void render(java.io.Writer p_writer,
                   java.util.Map<java.lang.String,java.lang.Object> p_argMap)
            throws TemplateInspector.InvalidTemplateException,
                   TemplateInspector.UnknownArgumentsException

Render the template.

Parameters:

p_writer - the Writer to render to

p_argMap - a Map<String,String> of arguments

Throws:

TemplateInspector.InvalidTemplateException

TemplateInspector.UnknownArgumentsException

render

public void render(java.io.Writer p_writer,
                   java.util.Map<java.lang.String,java.lang.Object> p_argMap,
                   boolean p_ignoreUnusedParams)
            throws TemplateInspector.InvalidTemplateException,
                   TemplateInspector.UnknownArgumentsException

Render the template.

Parameters:

p_writer - the Writer to render to

p_argMap - a Map<String,String> of arguments

p_ignoreUnusedParams - whether to throw an exception if "extra" arguments are supplied

Throws:

TemplateInspector.InvalidTemplateException

TemplateInspector.UnknownArgumentsException

getRequiredArgumentNames

public java.util.List<java.lang.String> getRequiredArgumentNames()

getOptionalArgumentNames

public java.util.List<java.lang.String> getOptionalArgumentNames()

getArgumentType

public java.lang.Class<?> getArgumentType(java.lang.String p_argName)