Package burp.api.montoya.ui.settings

Interface SettingsPanelBuilder

public interface SettingsPanelBuilder

Used to build an instance of SettingsPanelWithData.

Method Summary

Modifier and Type	Method	Description
SettingsPanelWithData	build()	Used to build the settings panel.
static SettingsPanelBuilder	settingsPanel()	Used to obtain an instance of the SettingsPanelBuilder.
SettingsPanelBuilder	withDescription(String description)	Sets the description to be displayed within Settings panel.
SettingsPanelBuilder	withKeywords(String... keywords)	A set of keywords used by the Settings search function to help users find the Settings panel.
SettingsPanelBuilder	withKeywords(Collection<String> keywords)	A set of keywords used by the Settings search function to help users find the Settings panel.
SettingsPanelBuilder	withPersistence(SettingsPanelPersistence persistence)	Sets the type of data persistence.
SettingsPanelBuilder	withSetting(SettingsPanelSetting entry)	Used to add a SettingsPanelSetting to the Settings panel.
SettingsPanelBuilder	withSettings(SettingsPanelSetting... entries)	Used to add multiple SettingsPanelSetting to the Settings panel.
SettingsPanelBuilder	withTitle(String title)	Sets the title to be displayed within Settings panel.

Method Details

withPersistence

SettingsPanelBuilder withPersistence(SettingsPanelPersistence persistence)

Sets the type of data persistence.

Parameters:

persistence - type of data persistence.

Returns:

instance of the builder.

withTitle

SettingsPanelBuilder withTitle(String title)

Sets the title to be displayed within Settings panel. If no title is set then the extension name will be used.

Parameters:

title - the title.

Returns:

instance of the builder.

withDescription

SettingsPanelBuilder withDescription(String description)

Sets the description to be displayed within Settings panel.

Parameters:

description - the description.

Returns:

instance of the builder.

withSetting

SettingsPanelBuilder withSetting(SettingsPanelSetting entry)

Used to add a SettingsPanelSetting to the Settings panel.

Parameters:

entry - the entry.

Returns:

instance of the builder.

withSettings

SettingsPanelBuilder withSettings(SettingsPanelSetting... entries)

Used to add multiple SettingsPanelSetting to the Settings panel.

Parameters:

entries - the entries.

Returns:

instance of the builder.

withKeywords

SettingsPanelBuilder withKeywords(String... keywords)

A set of keywords used by the Settings search function to help users find the Settings panel.

Returns:

instance of the builder.

withKeywords

SettingsPanelBuilder withKeywords(Collection<String> keywords)

A set of keywords used by the Settings search function to help users find the Settings panel.

Returns:

instance of the builder.

build

SettingsPanelWithData build()

Used to build the settings panel.

Returns:

the settings panel

settingsPanel

static SettingsPanelBuilder settingsPanel()

Used to obtain an instance of the SettingsPanelBuilder.

Returns:

an instance of the SettingsPanelBuilder.