Package org.eclipse.lsp4j

Class MarkupContent

  • public class MarkupContent
extends java.lang.Object
    A MarkupContent literal represents a string value which content is interpreted based on its kind flag. Currently the protocol supports plaintext and markdown as markup kinds.

    If the kind is markdown then the value can contain fenced code blocks like in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting

    Please Note that clients might sanitize the return markdown. A client could decide to remove HTML from the markdown to avoid script execution.

    Since 3.3.0

    • Constructor Summary

      Constructors 
      Constructor Description
      MarkupContent()  
      MarkupContent​(java.lang.String kind, java.lang.String value)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getKind()
      The type of the Markup.
      java.lang.String getValue()
      The content itself.
      int hashCode()  
      void setKind​(java.lang.String kind)
      The type of the Markup.
      void setValue​(java.lang.String value)
      The content itself.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MarkupContent

        public MarkupContent()

      • MarkupContent

        public MarkupContent​(java.lang.String kind,
                     java.lang.String value)

    • Method Detail

      • getKind

        public java.lang.String getKind()
        The type of the Markup.

        See MarkupKind for allowed values.

      • setKind

        public void setKind​(java.lang.String kind)
        The type of the Markup.

        See MarkupKind for allowed values.

      • getValue

        public java.lang.String getValue()
        The content itself.

      • setValue

        public void setValue​(java.lang.String value)
        The content itself.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object