Package freemarker.ext.dump

Class BaseDumpDirective

java.lang.Object

freemarker.ext.dump.BaseDumpDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

Direct Known Subclasses:

DumpAllDirective, DumpDirective, HelpDirective

public abstract class BaseDumpDirective
extends Object
implements freemarker.template.TemplateDirectiveModel

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor	Description
BaseDumpDirective()

Method Summary

Modifier and Type	Method	Description
protected void	dump(Map<String,Object> dump, freemarker.core.Environment env, String title)
protected void	dump(Map<String,Object> dump, freemarker.core.Environment env, String title, String templateName)
protected Map<String,Object>	getTemplateVariableDump(String varName, freemarker.core.Environment env)
protected Map<String,Object>	getTemplateVariableDump(String varName, freemarker.template.TemplateModel valueToDump)
Map<String,Object>	help(String name)
protected List<String>	junkToStrings(freemarker.template.TemplateCollectionModel junk)
protected Map<? extends String,? extends Object>	toMap(Object hash)	Convert a Freemarker TemplateObject to a usable map.
protected void	writeDump(Map<String,Object> map, freemarker.core.Environment env, String templateName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface freemarker.template.TemplateDirectiveModel

execute

Constructor Detail

BaseDumpDirective

public BaseDumpDirective()

Method Detail

getTemplateVariableDump

protected Map<String,Object> getTemplateVariableDump(String varName,
                                                           freemarker.core.Environment env)
                                                    throws freemarker.template.TemplateModelException

Throws:

freemarker.template.TemplateModelException

getTemplateVariableDump

protected Map<String,Object> getTemplateVariableDump(String varName,
                                                           freemarker.template.TemplateModel valueToDump)
                                                    throws freemarker.template.TemplateModelException

Throws:

freemarker.template.TemplateModelException

dump

protected void dump(Map<String,Object> dump,
                    freemarker.core.Environment env,
                    String title)
             throws freemarker.template.TemplateException,
                    IOException

Throws:

freemarker.template.TemplateException

IOException

dump

protected void dump(Map<String,Object> dump,
                    freemarker.core.Environment env,
                    String title,
                    String templateName)
             throws freemarker.template.TemplateException,
                    IOException

Throws:

freemarker.template.TemplateException

IOException

writeDump

protected void writeDump(Map<String,Object> map,
                         freemarker.core.Environment env,
                         String templateName)
                  throws freemarker.template.TemplateException,
                         IOException

Throws:

freemarker.template.TemplateException

IOException

help

public Map<String,Object> help(String name)

toMap

protected Map<? extends String,? extends Object> toMap(Object hash)
                                                      throws freemarker.template.TemplateModelException

Convert a Freemarker TemplateObject to a usable map.

Throws:

freemarker.template.TemplateModelException

junkToStrings

protected List<String> junkToStrings(freemarker.template.TemplateCollectionModel junk)