Package burp.api.montoya.core

Interface Annotations

  • public interface Annotations
    This interface represents annotations that can be applied to a message.

    • Method Detail

      • annotations

        static Annotations annotations()
        This method is used to construct empty annotations.
        Returns:
        The annotations.

      • annotations

        static Annotations annotations​(java.lang.String comment)
        This method is used to construct annotations from a comment.
        Parameters:
        comment - The comment of the annotation
        Returns:
        The annotations.

      • annotations

        static Annotations annotations​(HighlightColor highlightColor)
        This method is used to construct a annotations from a highlight color.
        Parameters:
        highlightColor - The highlight color of the annotation
        Returns:
        The annotations.

      • annotations

        static Annotations annotations​(java.lang.String comment,
                               HighlightColor highlightColor)
        This method is used to construct a annotations from a comment and a highlight color.
        Parameters:
        comment - The comment of the annotation
        highlightColor - The highlight color of the annotation
        Returns:
        The annotations.

      • comment

        java.lang.String comment()

      • withComment

        Annotations withComment​(java.lang.String comment)
        This method is used to construct a copy of the annotations with a new comment.
        Parameters:
        comment - The new comment.
        Returns:
        The new annotations.

      • withHighlightColor

        Annotations withHighlightColor​(HighlightColor highlightColor)
        This method is used to construct a copy of the annotations with a new highlight color.
        Parameters:
        highlightColor - The new highlight color.
        Returns:
        The new annotations.