public class MockOutputTool
extends Object
implements OutputToolIn-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
| Type Params | Return Type | Name and description |
|---|---|---|
|
public void |
copyResource(String srcPath, String dstPath)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.
|
|
public String |
getText(String fileName)Returns the content written to the given filename by writeToOutput, or null if no content has been written. |
|
public boolean |
isValidOutputArea(String fileName)Returns true if makeOutputArea was previously called with the given filename. |
|
public void |
makeOutputArea(String filename)Ensures that the supplied output location exists.
|
|
public String |
toString(){@inheritDoc} |
|
public void |
writeToOutput(String fileName, String text, String charset)Writes rendered text to the supplied output file.
|
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.
Returns the content written to the given filename by writeToOutput, or null if no content has been written.
Returns true if makeOutputArea was previously called with the given filename.
Ensures that the supplied output location exists.
filename - the output directory or root path to prepare{@inheritDoc}