Package org.codehaus.groovy.tools.groovydoc

Interface OutputTool

All Known Implementing Classes:

FileOutputTool, MockOutputTool

public interface OutputTool

Method Summary

Modifier and Type	Method	Description
void	copyResource(String srcPath, String dstPath)	Copy a resource file (doc-files/, snippet-files/ content) from srcPath to dstPath.
void	makeOutputArea(String filename)
void	writeToOutput(String fileName, String text, String charset)

Method Details

makeOutputArea

void makeOutputArea(String filename)

writeToOutput

void writeToOutput(String fileName,
 String text,
 String charset)
            throws Exception

Throws:

Exception

copyResource

void copyResource(String srcPath,
 String dstPath)
           throws Exception

Copy a resource file (doc-files/, snippet-files/ content) from srcPath to dstPath. Routed through the tool rather than calling Files.copy directly so that alternative tools (notably MockOutputTool) can intercept the side-effect.

Throws:

Exception