Package burp.api.montoya.core

Interface Annotations

public interface Annotations

Annotations stored with requests and responses in Burp Suite.

Method Summary

Modifier and Type	Method	Description
static Annotations	annotations()	Create a new empty annotations.
static Annotations	annotations(HighlightColor highlightColor)	Create a new annotations with a highlight color.
static Annotations	annotations(String notes)	Create a new annotations with notes.
static Annotations	annotations(String notes, HighlightColor highlightColor)	Create a new annotations with notes and a highlight color.
boolean	hasHighlightColor()
boolean	hasNotes()
HighlightColor	highlightColor()
String	notes()
void	setHighlightColor(HighlightColor highlightColor)	Set (mutate) the current annotations highlight color value
void	setNotes(String notes)	Set (mutate) the current annotations notes value
Annotations	withHighlightColor(HighlightColor highlightColor)	Create a copy of the annotations with a new highlight color.
Annotations	withNotes(String notes)	Create a copy of the annotations with new notes.

Method Details

notes

String notes()

Returns:

the notes

hasNotes

boolean hasNotes()

Returns:

True if there are any notes for this HTTP request and response.

hasHighlightColor

boolean hasHighlightColor()

Returns:

True if there is a highlight color for this HTTP request and response.

setNotes

void setNotes(String notes)

Set (mutate) the current annotations notes value

Parameters:

notes - the notes to set on the current annotations

highlightColor

HighlightColor highlightColor()

Returns:

the highlight color;

setHighlightColor

void setHighlightColor(HighlightColor highlightColor)

Set (mutate) the current annotations highlight color value

Parameters:

highlightColor - the highlight color to set on the current annotations

withNotes

Annotations withNotes(String notes)

Create a copy of the annotations with new notes.

Parameters:

notes - The new notes.

Returns:

The new annotations.

withHighlightColor

Annotations withHighlightColor(HighlightColor highlightColor)

Create a copy of the annotations with a new highlight color.

Parameters:

highlightColor - The new highlight color.

Returns:

The new annotations.

annotations

static Annotations annotations()

Create a new empty annotations.

Returns:

The annotations.

annotations

static Annotations annotations(String notes)

Create a new annotations with notes.

Parameters:

notes - The notes of the annotations

Returns:

The annotations.

annotations

static Annotations annotations(HighlightColor highlightColor)

Create a new annotations with a highlight color.

Parameters:

highlightColor - The highlight color of the annotations

Returns:

The annotations.

annotations

static Annotations annotations(String notes,
 HighlightColor highlightColor)

Create a new annotations with notes and a highlight color.

Parameters:

notes - The notes of the annotations

highlightColor - The highlight color of the annotations

Returns:

The annotations.