org.eclipse.golo.doc

Class AbstractProcessor

java.lang.Object

org.eclipse.golo.doc.AbstractProcessor

Direct Known Subclasses:

CtagsProcessor, HtmlProcessor, MarkdownProcessor

public abstract class AbstractProcessor
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	ensureFolderExists(java.nio.file.Path path)
protected java.lang.String	moduleName(ASTCompilationUnit unit)
protected java.nio.file.Path	outputFile(java.nio.file.Path targetFolder, java.lang.String moduleName, java.lang.String extension)
abstract void	process(java.util.Map<java.lang.String,ASTCompilationUnit> units, java.nio.file.Path targetFolder)
abstract java.lang.String	render(ASTCompilationUnit compilationUnit)
protected FunctionReference	template(java.lang.String name, java.lang.String format)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

render

public abstract java.lang.String render(ASTCompilationUnit compilationUnit)
                                 throws java.lang.Throwable

Throws:

java.lang.Throwable

process

public abstract void process(java.util.Map<java.lang.String,ASTCompilationUnit> units,
                             java.nio.file.Path targetFolder)
                      throws java.lang.Throwable

Throws:

java.lang.Throwable

template

protected FunctionReference template(java.lang.String name,
                                     java.lang.String format)
                              throws java.io.IOException

Throws:

java.io.IOException

ensureFolderExists

protected void ensureFolderExists(java.nio.file.Path path)
                           throws java.io.IOException

Throws:

java.io.IOException

outputFile

protected java.nio.file.Path outputFile(java.nio.file.Path targetFolder,
                                        java.lang.String moduleName,
                                        java.lang.String extension)

moduleName

protected java.lang.String moduleName(ASTCompilationUnit unit)