Package burp.api.montoya.ui.menu

Interface Menu

public interface Menu

A menu to be displayed in the MenuBar.

Method Summary

Modifier and Type	Method	Description
String	caption()	The caption to be displayed for the menu.
static Menu	menu(String caption)	Create a new instance of Menu.
List<MenuItem>	menuItems()	The list of MenuItem that will be displayed in the menu.
Menu	withCaption(String caption)	Create a copy of Menu with a new caption.
Menu	withMenuItems(MenuItem... menuItems)	Create a copy of Menu with one or more instances of MenuItem.
Menu	withMenuItems(List<MenuItem> menuItems)	Create a copy of Menu with a new list of MenuItem.

Method Details

caption

String caption()

The caption to be displayed for the menu.

Returns:

The caption

menuItems

List<MenuItem> menuItems()

The list of MenuItem that will be displayed in the menu.

Returns:

The list of MenuItem.

withCaption

Menu withCaption(String caption)

Create a copy of Menu with a new caption.

Parameters:

caption - The new caption.

Returns:

An updated copy of Menu.

withMenuItems

Menu withMenuItems(MenuItem... menuItems)

Create a copy of Menu with one or more instances of MenuItem.

Parameters:

menuItems - One or more instances of MenuItem.

Returns:

An updated copy of Menu.

withMenuItems

Menu withMenuItems(List<MenuItem> menuItems)

Create a copy of Menu with a new list of MenuItem.

Parameters:

menuItems - The new list of MenuItem.

Returns:

An updated copy of Menu.

menu

static Menu menu(String caption)

Create a new instance of Menu.

Parameters:

caption - The caption for the menu.

Returns:

A new instance of Menu.