org.codehaus.groovy.tools.groovydoc
Class GroovyDocTemplateEngine

java.lang.Object
  extended by org.codehaus.groovy.tools.groovydoc.GroovyDocTemplateEngine

public class GroovyDocTemplateEngine
extends java.lang.Object

Process Groovydoc templates.


Field Summary
private  java.util.List<java.lang.String> classTemplatePaths
           
private  java.util.Map<java.lang.String,Template> classTemplates
           
private  java.util.List<java.lang.String> docTemplatePaths
           
private  java.util.Map<java.lang.String,Template> docTemplates
           
private  TemplateEngine engine
           
private  java.util.List<java.lang.String> packageTemplatePaths
           
private  java.util.Map<java.lang.String,Template> packageTemplates
           
private  java.util.Properties properties
           
private  ResourceManager resourceManager
           
private  GroovyDocTool tool
           
 
Constructor Summary
GroovyDocTemplateEngine(GroovyDocTool tool, ResourceManager resourceManager, java.lang.String classTemplate)
           
GroovyDocTemplateEngine(GroovyDocTool tool, ResourceManager resourceManager, java.lang.String[] docTemplates, java.lang.String[] packageTemplates, java.lang.String[] classTemplates, java.util.Properties properties)
           
 
Method Summary
(package private)  java.lang.String applyClassTemplates(GroovyClassDoc classDoc)
           
(package private)  java.lang.String applyPackageTemplate(java.lang.String template, GroovyPackageDoc packageDoc)
           
(package private)  java.lang.String applyRootDocTemplate(java.lang.String template, GroovyRootDoc rootDoc)
           
(package private)  java.util.Iterator<java.lang.String> classTemplatesIterator()
           
 void copyBinaryResource(java.lang.String template, java.lang.String destFileName)
           
(package private)  java.util.Iterator<java.lang.String> docTemplatesIterator()
           
(package private)  java.util.Iterator<java.lang.String> packageTemplatesIterator()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

engine

private TemplateEngine engine

tool

private GroovyDocTool tool

resourceManager

private ResourceManager resourceManager

properties

private java.util.Properties properties

docTemplates

private java.util.Map<java.lang.String,Template> docTemplates

docTemplatePaths

private java.util.List<java.lang.String> docTemplatePaths

packageTemplates

private java.util.Map<java.lang.String,Template> packageTemplates

packageTemplatePaths

private java.util.List<java.lang.String> packageTemplatePaths

classTemplates

private java.util.Map<java.lang.String,Template> classTemplates

classTemplatePaths

private java.util.List<java.lang.String> classTemplatePaths
Constructor Detail

GroovyDocTemplateEngine

public GroovyDocTemplateEngine(GroovyDocTool tool,
                               ResourceManager resourceManager,
                               java.lang.String classTemplate)

GroovyDocTemplateEngine

public GroovyDocTemplateEngine(GroovyDocTool tool,
                               ResourceManager resourceManager,
                               java.lang.String[] docTemplates,
                               java.lang.String[] packageTemplates,
                               java.lang.String[] classTemplates,
                               java.util.Properties properties)
Method Detail

applyClassTemplates

java.lang.String applyClassTemplates(GroovyClassDoc classDoc)

applyPackageTemplate

java.lang.String applyPackageTemplate(java.lang.String template,
                                      GroovyPackageDoc packageDoc)

applyRootDocTemplate

java.lang.String applyRootDocTemplate(java.lang.String template,
                                      GroovyRootDoc rootDoc)

classTemplatesIterator

java.util.Iterator<java.lang.String> classTemplatesIterator()

packageTemplatesIterator

java.util.Iterator<java.lang.String> packageTemplatesIterator()

docTemplatesIterator

java.util.Iterator<java.lang.String> docTemplatesIterator()

copyBinaryResource

public void copyBinaryResource(java.lang.String template,
                               java.lang.String destFileName)


Copyright © ${year} The Codehaus. All Rights Reserved.