public class FileOutputTool
extends Object
implements OutputToolWrites generated documentation and copied resources to the file system.
| 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 void |
makeOutputArea(String filename)Ensures that the supplied output location exists.
|
|
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.
Ensures that the supplied output location exists.
filename - the output directory or root path to prepare