Package com.structurizr.importer.documentation

Class Log4brainsDecisionImporter

java.lang.Object
com.structurizr.importer.documentation.AbstractDecisionImporter
com.structurizr.importer.documentation.Log4brainsDecisionImporter
All Implemented Interfaces:
DocumentationImporter
public class Log4brainsDecisionImporter extends AbstractDecisionImporter
Imports architecture decision records created/managed by Log4brains (https://github.com/thomvaill/log4brains). See https://github.com/thomvaill/log4brains/blob/master/docs/adr/template.md for the template.

  • Constructor Details

    • Log4brainsDecisionImporter

      public Log4brainsDecisionImporter()

  • Method Details

    • importDocumentation

      public void importDocumentation(com.structurizr.documentation.Documentable documentable, File path)
      Imports Markdown files from the specified path, one per decision.
      Parameters:
      documentable - the item that decisions should be associated with
      path - the path to import decisions from

    • importDecision

      protected com.structurizr.documentation.Decision importDecision(int id, File file) throws Exception
      Throws:
      Exception

    • extractDateFromFilename

      protected Date extractDateFromFilename(File file) throws Exception
      Throws:
      Exception

    • extractTitle

      protected String extractTitle(String[] lines)

    • extractDate

      protected Date extractDate(String[] lines) throws Exception
      Throws:
      Exception

    • extractStatus

      protected String extractStatus(String[] lines)

    • extractLinks

      protected void extractLinks(com.structurizr.documentation.Decision decision, Map<String,com.structurizr.documentation.Decision> decisionsByFilename)

    • calculateUrl

      protected String calculateUrl(com.structurizr.documentation.Decision decision) throws Exception
      Throws:
      Exception

    • urlEncode

      protected String urlEncode(String value) throws Exception
      Throws:
      Exception