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


Field Summary
private  java.util.List classTemplatePaths
           
private  java.util.Map classTemplates
           
private  java.util.List docTemplatePaths
           
private  java.util.Map docTemplates
           
private  TemplateEngine engine
           
private  java.util.List packageTemplatePaths
           
private  java.util.Map packageTemplates
           
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)
           
 
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 classTemplatesIterator()
           
(package private)  java.util.Iterator docTemplatesIterator()
           
(package private)  java.util.Iterator 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

docTemplates

private java.util.Map docTemplates

docTemplatePaths

private java.util.List docTemplatePaths

packageTemplates

private java.util.Map packageTemplates

packageTemplatePaths

private java.util.List packageTemplatePaths

classTemplates

private java.util.Map classTemplates

classTemplatePaths

private java.util.List 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)
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 classTemplatesIterator()

packageTemplatesIterator

java.util.Iterator packageTemplatesIterator()

docTemplatesIterator

java.util.Iterator docTemplatesIterator()


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