Package org.jacoco.report.internal

Class ReportOutputFolder

  • public class ReportOutputFolder
extends java.lang.Object
    Logical representation of a folder in the output structure. This utility ensures valid and unique file names and helps to create relative links.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.OutputStream createFile​(java.lang.String name)
      Creates a new file in this folder with the given local name.
      java.lang.String getLink​(ReportOutputFolder base, java.lang.String name)
      Returns a link relative to a given base to a resource within this folder.
      ReportOutputFolder subFolder​(java.lang.String name)
      Creates a sub-folder with the given name.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReportOutputFolder

        public ReportOutputFolder​(IMultiReportOutput output)
        Creates a new root folder for the given output.
        Parameters:
        output - output for generated files

    • Method Detail

      • subFolder

        public ReportOutputFolder subFolder​(java.lang.String name)
        Creates a sub-folder with the given name.
        Parameters:
        name - name of the sub-folder
        Returns:
        handle for output into the sub-folder

      • createFile

        public java.io.OutputStream createFile​(java.lang.String name)
                                throws java.io.IOException
        Creates a new file in this folder with the given local name.
        Parameters:
        name - name of the sub-folder
        Returns:
        handle for output into the sub-folder
        Throws:
        java.io.IOException - if the file creation fails

      • getLink

        public java.lang.String getLink​(ReportOutputFolder base,
                                java.lang.String name)
        Returns a link relative to a given base to a resource within this folder.
        Parameters:
        base - base to create the relative link from
        name - name of the file or folder in this folder
        Returns:
        relative link
        Throws:
        java.lang.IllegalArgumentException - if this folder and the base do not have the same root