Class MermaidConfiguration

java.lang.Object
org.apache.maven.doxia.site.MermaidConfiguration
All Implemented Interfaces:
Serializable, Cloneable
public class MermaidConfiguration extends Object implements Serializable, Cloneable
The configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side.
Version:
$Revision$ $Date$
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    config
    The Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
    private ExternalJs
    externalJs
    The URL from which to request the javascript used for rendering the diagrams.
    private boolean
    useTiny
    If Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MermaidConfiguration()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    MermaidConfiguration
    clone()
    Method clone.
    boolean
    equals(Object other)
    Method equals.
    String
    getConfig()
    Get the Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
    ExternalJs
    getExternalJs()
    Get the URL from which to request the javascript used for rendering the diagrams.
    int
    hashCode()
    Method hashCode.
    boolean
    isUseTiny()
    Get if Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used.
    void
    setConfig(String config)
    Set the Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
    void
    setExternalJs(ExternalJs externalJs)
    Set the URL from which to request the javascript used for rendering the diagrams.
    void
    setUseTiny(boolean useTiny)
    Set if Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used.
    String
    toString()
    Method toString.

    Methods inherited from class Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • externalJs

      private ExternalJs externalJs
      The URL from which to request the javascript used for rendering the diagrams. If not set an embedded version of Mermaid is used (which is automatically deployed to the site)

    • useTiny

      private boolean useTiny
      If Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used. Only considered if "externalJsUrl" is not set

    • config

      private String config
      The Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.

  • Constructor Details

    • MermaidConfiguration

      public MermaidConfiguration()

  • Method Details

    • clone

      public MermaidConfiguration clone()
      Method clone.
      Overrides:
      clone in class Object
      Returns:
      MermaidConfiguration

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean

    • getConfig

      public String getConfig()
      Get the Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
      Returns:
      String

    • getExternalJs

      public ExternalJs getExternalJs()
      Get the URL from which to request the javascript used for rendering the diagrams. If not set an embedded version of Mermaid is used (which is automatically deployed to the site).
      Returns:
      ExternalJs

    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int

    • isUseTiny

      public boolean isUseTiny()
      Get if Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used. Only considered if "externalJsUrl" is not set.
      Returns:
      boolean

    • setConfig

      public void setConfig(String config)
      Set the Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
      Parameters:
      config - a config object.

    • setExternalJs

      public void setExternalJs(ExternalJs externalJs)
      Set the URL from which to request the javascript used for rendering the diagrams. If not set an embedded version of Mermaid is used (which is automatically deployed to the site).
      Parameters:
      externalJs - a externalJs object.

    • setUseTiny

      public void setUseTiny(boolean useTiny)
      Set if Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used. Only considered if "externalJsUrl" is not set.
      Parameters:
      useTiny - a useTiny object.

    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String