Package com.structurizr.io.plantuml

Class PlantUMLWriter

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addIncludeFile​(java.lang.String file)  
      void addIncludeFile​(java.lang.String file, int id)  
      void addIncludeFile​(java.lang.String file, java.lang.String id)  
      void addIncludeURL​(java.net.URI file)  
      void addIncludeURL​(java.net.URI file, int id)  
      void addIncludeURL​(java.net.URI file, java.lang.String id)  
      void addSkinParam​(java.lang.String name, java.lang.String value)  
      void clearIncludes()  
      void clearSkinParams()  
      java.util.List<java.lang.String> getIncludes()  
      protected java.util.Map<java.lang.String,​java.lang.String> getSkinParams()  
      boolean isIncludeDiagramMetadata()  
      boolean isUseSequenceDiagrams()  
      void setIncludeDiagramMetadata​(boolean includeDiagramMetadata)  
      void setUseSequenceDiagrams​(boolean useSequenceDiagrams)  
      java.util.Collection<PlantUMLDiagram> toPlantUMLDiagrams​(com.structurizr.Workspace workspace)
      Creates PlantUML diagram definitions based upon the specified workspace.
      java.lang.String toString​(com.structurizr.view.View view)
      Gets a single view as a PlantUML diagram definition.
      protected abstract void write​(com.structurizr.view.ComponentView view, java.io.Writer writer)  
      protected abstract void write​(com.structurizr.view.ContainerView view, java.io.Writer writer)  
      protected abstract void write​(com.structurizr.view.DynamicView view, java.io.Writer writer)  
      protected void write​(com.structurizr.view.SystemContextView view, java.io.Writer writer)  
      protected void write​(com.structurizr.view.SystemLandscapeView view, java.io.Writer writer)  
      protected abstract void write​(com.structurizr.view.View view, com.structurizr.model.DeploymentNode deploymentNode, java.io.Writer writer, int indent)  
      protected abstract void write​(com.structurizr.view.View view, com.structurizr.model.Element element, java.io.Writer writer, int indent)  
      void write​(com.structurizr.view.View view, java.io.Writer writer)
      Writes a single view as a PlantUML diagram definition, to the specified writer.
      void write​(com.structurizr.Workspace workspace, java.io.Writer writer)
      Writes the views in the given workspace as PlantUML definitions, to the specified writer.
      protected void writeFooter​(java.io.Writer writer)  
      protected void writeHeader​(com.structurizr.view.View view, java.io.Writer writer)  
      protected abstract void writeRelationship​(com.structurizr.view.View view, com.structurizr.view.RelationshipView relationshipView, java.io.Writer writer)  
      protected void writeRelationships​(com.structurizr.view.View view, java.io.Writer writer)  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getIncludes

        public java.util.List<java.lang.String> getIncludes()

      • addIncludeFile

        public void addIncludeFile​(java.lang.String file)

      • addIncludeFile

        public void addIncludeFile​(java.lang.String file,
                           int id)

      • addIncludeFile

        public void addIncludeFile​(java.lang.String file,
                           java.lang.String id)

      • addIncludeURL

        public void addIncludeURL​(java.net.URI file)

      • addIncludeURL

        public void addIncludeURL​(java.net.URI file,
                          int id)

      • addIncludeURL

        public void addIncludeURL​(java.net.URI file,
                          java.lang.String id)

      • clearIncludes

        public void clearIncludes()

      • getSkinParams

        protected java.util.Map<java.lang.String,​java.lang.String> getSkinParams()

      • addSkinParam

        public void addSkinParam​(java.lang.String name,
                         java.lang.String value)

      • clearSkinParams

        public void clearSkinParams()

      • isUseSequenceDiagrams

        public boolean isUseSequenceDiagrams()

      • setUseSequenceDiagrams

        public void setUseSequenceDiagrams​(boolean useSequenceDiagrams)

      • isIncludeDiagramMetadata

        public boolean isIncludeDiagramMetadata()

      • setIncludeDiagramMetadata

        public void setIncludeDiagramMetadata​(boolean includeDiagramMetadata)

      • write

        public final void write​(com.structurizr.Workspace workspace,
                        java.io.Writer writer)
        Writes the views in the given workspace as PlantUML definitions, to the specified writer.
        Parameters:
        workspace - the workspace containing the views to be written
        writer - the Writer to write to

      • toString

        public final java.lang.String toString​(com.structurizr.view.View view)
        Gets a single view as a PlantUML diagram definition.
        Parameters:
        view - the view to write
        Returns:
        the PlantUML definition as a String

      • toPlantUMLDiagrams

        public final java.util.Collection<PlantUMLDiagram> toPlantUMLDiagrams​(com.structurizr.Workspace workspace)
        Creates PlantUML diagram definitions based upon the specified workspace.
        Parameters:
        workspace - the workspace containing the views to be written
        Returns:
        a collection of PlantUML diagram definitions, one per view

      • write

        public final void write​(com.structurizr.view.View view,
                        java.io.Writer writer)
        Writes a single view as a PlantUML diagram definition, to the specified writer.
        Parameters:
        view - the view to write
        writer - the Writer to write the PlantUML definition to

      • write

        protected void write​(com.structurizr.view.SystemLandscapeView view,
                     java.io.Writer writer)

      • write

        protected void write​(com.structurizr.view.SystemContextView view,
                     java.io.Writer writer)

      • write

        protected abstract void write​(com.structurizr.view.ContainerView view,
                              java.io.Writer writer)

      • write

        protected abstract void write​(com.structurizr.view.ComponentView view,
                              java.io.Writer writer)

      • write

        protected abstract void write​(com.structurizr.view.DynamicView view,
                              java.io.Writer writer)

      • write

        protected abstract void write​(com.structurizr.view.View view,
                              com.structurizr.model.DeploymentNode deploymentNode,
                              java.io.Writer writer,
                              int indent)

      • write

        protected abstract void write​(com.structurizr.view.View view,
                              com.structurizr.model.Element element,
                              java.io.Writer writer,
                              int indent)

      • writeHeader

        protected void writeHeader​(com.structurizr.view.View view,
                           java.io.Writer writer)
                    throws java.io.IOException
        Throws:
        java.io.IOException

      • writeRelationships

        protected void writeRelationships​(com.structurizr.view.View view,
                                  java.io.Writer writer)

      • writeRelationship

        protected abstract void writeRelationship​(com.structurizr.view.View view,
                                          com.structurizr.view.RelationshipView relationshipView,
                                          java.io.Writer writer)

      • writeFooter

        protected void writeFooter​(java.io.Writer writer)
                    throws java.io.IOException
        Throws:
        java.io.IOException