java.lang.Object
io.spring.initializr.generator.spring.documentation.HelpDocument

public class HelpDocument extends Object
Project's help document intended to give additional references to the users. Contains a getting started section, additional sections and a next steps section.
Author:
Stephane Nicoll, Madhura Bhave
  • Constructor Details

  • Method Details

    • getWarnings

      public BulletedSection<String> getWarnings()
      Return a section that can be used to inform the user that something happened when building this project.
      Returns:
      a warnings section rendered as bullet points
    • gettingStarted

      public GettingStartedSection gettingStarted()
    • nextSteps

      public PreDefinedSection nextSteps()
    • addSection

      public HelpDocument addSection(Section section)
    • addSection

      public HelpDocument addSection(String templateName, Map<String,Object> model)
      Add a section rendered by the specified mustache template and model.
      Parameters:
      templateName - the name of the mustache template to render
      model - the model that should be used for the rendering
      Returns:
      this document
    • getSections

      public List<Section> getSections()
    • write

      public void write(PrintWriter writer) throws IOException
      Throws:
      IOException
    • isEmpty

      public boolean isEmpty()