Package: org.codehaus.groovy.tools.groovydoc

## [Java] Class MockOutputTool

- org.codehaus.groovy.tools.groovydoc.MockOutputTool

- All Implemented Interfaces and Traits:
    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.

- - ### 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`. 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 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. Parameters: `filename` - the output directory or root path to prepare
    `` | `public String` | `toString()` {@inheritDoc}
    `` | `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

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

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

    - #### public String toString()

      {@inheritDoc}

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