Package org.codehaus.groovy.tools.groovydoc

Class MockOutputTool

java.lang.Object

org.codehaus.groovy.tools.groovydoc.MockOutputTool

All Implemented Interfaces:

OutputTool

public class MockOutputTool
extends Object
implements OutputTool

In-memory OutputTool used by tests. Nothing is written to disk by default, so test runs leave no filesystem artifacts.

Debugging: pass the groovydoc.mockOutputTool.dumpDir system property to also mirror every output call to that directory. Example (from the groovy-groovydoc module):

 ./gradlew :groovy-groovydoc:test -Dgroovydoc.mockOutputTool.dumpDir=build/mock-dump
 

When the property is unset, all calls are captured only in the in-memory output and outputAreas maps; inspect them via getText(String) or via a debugger breakpoint.

Constructor Summary

Constructors

Constructor	Description
MockOutputTool()

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.
String	getText(String fileName)
boolean	isValidOutputArea(String fileName)
void	makeOutputArea(String filename)
String	toString()
void	writeToOutput(String fileName, String text, String charset)

Methods inherited from class java.lang.Object

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

Constructor Details

MockOutputTool

public MockOutputTool()

Method Details

makeOutputArea

public void makeOutputArea(String filename)

Specified by:

makeOutputArea in interface OutputTool

writeToOutput

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

Specified by:

writeToOutput in interface OutputTool

Throws:

Exception

copyResource

public void copyResource(String srcPath,
 String dstPath)
                  throws IOException

Description copied from interface: OutputTool

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.

Specified by:

copyResource in interface OutputTool

Throws:

IOException

isValidOutputArea

public boolean isValidOutputArea(String fileName)

getText

public String getText(String fileName)

toString

public String toString()

Overrides:

toString in class Object