Package org.apache.maven.doxia.site

Class MermaidConfiguration

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MermaidConfiguration clone()
      Method clone.
      boolean equals​(java.lang.Object other)
      Method equals.
      java.lang.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​(java.lang.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.
      java.lang.String toString()
      Method toString.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MermaidConfiguration

        public MermaidConfiguration()

    • Method Detail

      • clone

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

      • equals

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

      • getConfig

        public java.lang.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 java.lang.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​(java.lang.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 java.lang.String toString()
        Method toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String