Package com.structurizr.view

Class ThemeUtils

java.lang.Object
com.structurizr.view.ThemeUtils
public final class ThemeUtils extends Object
Some utility methods for exporting themes to JSON.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ThemeUtils()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    inlineTheme(com.structurizr.Workspace workspace, File file)
    Inlines the element and relationship styles from the specified file, adding the styles into the workspace and overriding any properties already set.
    static void
    loadThemes(com.structurizr.Workspace workspace)
    Loads the element and relationship styles from the themes defined in the workspace, into the workspace itself.
    static void
    loadThemes(com.structurizr.Workspace workspace, int timeoutInMilliseconds)
    Loads the element and relationship styles from the themes defined in the workspace, into the workspace itself.
    static String
    toJson(com.structurizr.Workspace workspace)
    Serializes the theme (element and relationship styles) in the specified workspace to a JSON string.
    static void
    toJson(com.structurizr.Workspace workspace, File file)
    Serializes the theme (element and relationship styles) in the specified workspace to a file, as a JSON string.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ThemeUtils

      public ThemeUtils()

  • Method Details

    • toJson

      public static void toJson(com.structurizr.Workspace workspace, File file) throws Exception
      Serializes the theme (element and relationship styles) in the specified workspace to a file, as a JSON string.
      Parameters:
      workspace - a Workspace object
      file - a File representing the JSON definition
      Throws:
      Exception - if something goes wrong

    • toJson

      public static String toJson(com.structurizr.Workspace workspace) throws Exception
      Serializes the theme (element and relationship styles) in the specified workspace to a JSON string.
      Parameters:
      workspace - a Workspace instance
      Returns:
      a JSON string
      Throws:
      Exception - if something goes wrong

    • loadThemes

      public static void loadThemes(com.structurizr.Workspace workspace) throws Exception
      Loads the element and relationship styles from the themes defined in the workspace, into the workspace itself. This implementation simply copies the styles from all themes into the workspace. This uses a default timeout value of 10000ms.
      Parameters:
      workspace - a Workspace object
      Throws:
      Exception - if something goes wrong

    • loadThemes

      public static void loadThemes(com.structurizr.Workspace workspace, int timeoutInMilliseconds) throws Exception
      Loads the element and relationship styles from the themes defined in the workspace, into the workspace itself. This implementation simply copies the styles from all themes into the workspace.
      Parameters:
      workspace - a Workspace object
      timeoutInMilliseconds - the timeout in milliseconds
      Throws:
      Exception - if something goes wrong

    • inlineTheme

      public static void inlineTheme(com.structurizr.Workspace workspace, File file) throws Exception
      Inlines the element and relationship styles from the specified file, adding the styles into the workspace and overriding any properties already set.
      Parameters:
      workspace - the Workspace to load the theme into
      file - a File object representing a theme (a JSON file)
      Throws:
      Exception - if something goes wrong