Package net.sourceforge.plantuml.servlet.utility

Class UrlDataExtractor

java.lang.Object
net.sourceforge.plantuml.servlet.utility.UrlDataExtractor
public abstract class UrlDataExtractor extends Object
Utility class to extract the index and diagram source from an URL, e.g., returned by `request.getRequestURI()`.

  • Constructor Details

    • UrlDataExtractor

      public UrlDataExtractor()

  • Method Details

    • getIndex

      public static int getIndex(String url)
      Get diagram index from URL.
      Parameters:
      url - URL to analyse, e.g., returned by `request.getRequestURI()`
      Returns:
      if exists diagram index; otherwise -1

    • getIndex

      public static int getIndex(String url, int fallback)
      Get diagram index from URL.
      Parameters:
      url - URL to analyse, e.g., returned by `request.getRequestURI()`
      fallback - fallback index if no index exists in url
      Returns:
      if exists diagram index; otherwise fallback

    • getEncodedDiagram

      public static String getEncodedDiagram(String url)
      Get encoded diagram source from URL.
      Parameters:
      url - URL to analyse, e.g., returned by `request.getRequestURI()`
      Returns:
      if exists diagram index; otherwise `null`

    • getEncodedDiagram

      public static String getEncodedDiagram(String url, String fallback)
      Get encoded diagram source from URL.
      Parameters:
      url - URL to analyse, e.g., returned by `request.getRequestURI()`
      fallback - fallback if no encoded diagram source exists in url
      Returns:
      if exists diagram index; otherwise fallback

    • isDarkModeUrl

      public static Boolean isDarkModeUrl(String url)
      Determines whether the UML diagram should be rendered in dark mode based on the URL.

      If the URL contains a diagram output type prefixed with d, the UML diagram will be rendered in dark mode by default.

      Examples:

      • /diagram/dsvg -> dark mode
      • /diagram/svg -> light mode
      Parameters:
      url - the URL to analyze, e.g., obtained from request.getRequestURI()
      Returns:
      true if the UML diagram should be rendered in dark mode, false if it should not, or null if the URL could not be analyzed