Package: org.codehaus.groovy.tools.groovydoc

## [Java] Interface OutputTool

-     public interface OutputTool

  Receives rendered documentation output and supporting resource copies.

- - ### Methods Summary

    Methods
    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`.
    `` | `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.

- - ### Method Detail

    - #### 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.

      Since:
        6.0.0

    - #### public void makeOutputArea(String filename)

      Ensures that the supplied output location exists.

      Parameters:
        `filename` - the output directory or root path to prepare

    - #### public void writeToOutput(String fileName, String text, String charset)

      Writes rendered text to the supplied output file.

      throws:
        Exception if the output cannot be written
      Parameters:
        `fileName` - the file to write
        `text` - the rendered content
        `charset` - the character set to use when writing