Class AbstractDecisionImporter
java.lang.Object
com.structurizr.importer.documentation.AbstractDecisionImporter
- All Implemented Interfaces:
DocumentationImporter
- Direct Known Subclasses:
AdrToolsDecisionImporter,Log4brainsDecisionImporter,MadrDecisionImporter
Imports architecture decision records created/managed by adr-tools (https://github.com/npryce/adr-tools).
The format for ADRs is as follows:
Filename: {DECISION_ID:0000}-*.md
Content:
# {DECISION_ID}. {DECISION_TITLE}
Date: {DECISION_DATE:YYYY-MM-DD}
## Status
{DECISION_STATUS and links}
## Context
...
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidsetCharacterEncoding(Charset characterEncoding) Provides a way to change the character encoding used by the DSL parser.voidsetTimeZone(String timeZone) Sets the time zone to use when parsing dates (the default is UTC)voidsetTimeZone(TimeZone timeZone) Sets the time zone to use when parsing dates.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.structurizr.importer.documentation.DocumentationImporter
importDocumentation
-
Field Details
-
timeZone
-
characterEncoding
-
-
Constructor Details
-
AbstractDecisionImporter
public AbstractDecisionImporter()
-
-
Method Details
-
setTimeZone
Sets the time zone to use when parsing dates (the default is UTC)- Parameters:
timeZone- a time zone as a String (e.g. "Europe/London" or "UTC")
-
setTimeZone
Sets the time zone to use when parsing dates.- Parameters:
timeZone- a TimeZone instance
-
setCharacterEncoding
Provides a way to change the character encoding used by the DSL parser.- Parameters:
characterEncoding- a Charset instance
-