Package outputProviders.logGenerator.pages

Interface PageGenerator

All Known Implementing Classes:
AboutFuzzerPageGenerator, AllMapsPageGenerator, HomePageGenerator, OverviewAndConclusionsPageGenerator, WelcomePageGenerator
public interface PageGenerator
Interface for generating an HTML page.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    alterHTMLTemplate(String templatePath)
    Alter the HTML template of the page appropriate for the specific implementation.
    default String
    generateHTMLPage(String templatePath, String destinationPath)
    Generates the HTML page from the template and writes it to a file by calling the appropriate methods.
    default String
    readTemplate(String templatePathLocation)
    Read the template HTML file to a byte string, ready for modification.
    default void
    writeHTMLPage(String destinationPath, String alteredTemplate)
    Write the generated HTML to a file.

  • Method Details

    • generateHTMLPage

      default String generateHTMLPage(String templatePath, String destinationPath)
      Generates the HTML page from the template and writes it to a file by calling the appropriate methods.
      Parameters:
      templatePath - The path to the template file.
      destinationPath - The path to the file to write the HTML to.
      Returns:
      String The altered HTML template, as String (after read in bytes and altered).

    • alterHTMLTemplate

      String alterHTMLTemplate(String templatePath)
      Alter the HTML template of the page appropriate for the specific implementation.
      Parameters:
      templatePath - The path to the template file.
      Returns:
      String The altered HTML template, as String (after read in bytes and altered).

    • readTemplate

      default String readTemplate(String templatePathLocation)
      Read the template HTML file to a byte string, ready for modification.
      Parameters:
      templatePathLocation - The path to the template file.
      Returns:
      String The template HTML file as a byte string, ready for modification.

    • writeHTMLPage

      default void writeHTMLPage(String destinationPath, String alteredTemplate)
      Write the generated HTML to a file.
      Parameters:
      destinationPath - The path to the file to write the HTML to.
      alteredTemplate - The altered HTML template, as String (after read in bytes and altered).