Package net.sourceforge.plantuml.mcp

Class McpResult

java.lang.Object
net.sourceforge.plantuml.mcp.McpResult
public class McpResult extends Object

  • Constructor Details

    • McpResult

      public McpResult(Diagram diagram)

    • McpResult

      public McpResult(Diagram diagram, String svg)

  • Method Details

    • renderError

      public static McpResult renderError(Diagram diagram, String message)
      Builds a result for a diagram that parsed correctly but failed to render. The structured counters from diagram are kept, but the result is marked as not OK and carries the rendering error message.
      Parameters:
      diagram - the parsed (non-error) diagram
      message - the rendering error message
      Returns:
      a not-OK result describing the rendering failure

    • badInput

      public static McpResult badInput()

    • noAtStart

      public static McpResult noAtStart()

    • isOk

      public boolean isOk()
      Returns:
      true if the source parsed without error

    • getDiagramType

      public String getDiagramType()
      Returns:
      the detected diagram type when OK (e.g. "SequenceDiagram"), or null when not applicable

    • getLineCount

      public int getLineCount()
      Returns:
      the number of source lines of the checked diagram

    • getWarnings

      public List<String> getWarnings()
      Returns:
      the non-fatal warnings, never null (possibly empty)

    • getErrorLineNumber

      public int getErrorLineNumber()
      Returns:
      the 1-based line of the error, or -1 when isOk() is true

    • getErrorMessage

      public String getErrorMessage()
      Returns:
      the error message, or null when isOk() is true

    • getErrorLine

      public String getErrorLine()

    • getErrorContext

      public String getErrorContext()
      Returns:
      the offending source line, or null when not available

    • getSvg

      public String getSvg()