org.zaproxy.zap.view.messagecontainer

Interface MultipleMessagesContainer<T extends Message>

Type Parameters:

T - the type of messages in this container

All Superinterfaces:

MessageContainer<T>, SingleMessageContainer<T>

All Known Subinterfaces:

MultipleHistoryReferencesContainer, MultipleHttpMessagesContainer, SelectableHistoryReferencesContainer, SelectableHttpMessagesContainer, SelectableMessagesContainer<T>

All Known Implementing Classes:

DefaultMultipleHistoryReferencesContainer, DefaultMultipleHttpMessagesContainer, DefaultSelectableHistoryReferencesContainer, DefaultSelectableHttpMessagesContainer

public interface MultipleMessagesContainer<T extends Message>
extends SingleMessageContainer<T>

A MessageContainer that can contain multiple messages.

Since:

2.3.0

See Also:

MessageContainer, SelectableMessagesContainer, SingleMessageContainer

Method Summary

Modifier and Type	Method and Description
T	getMessage() Returns the contained message.
List<T>	getMessages() Returns all the contained messages or an empty List if none.
int	getNumberOfMessages() Returns the number of contained messages.

Methods inherited from interface org.zaproxy.zap.view.messagecontainer.MessageContainer

getComponent, getMessageClass, getName, isEmpty

Method Detail

getMessage

T getMessage()

Returns the contained message. Might be null if no message is present or an error occurred while getting the message (for example, failed to read a persisted message).

If multiple messages are present the first one is returned.

Specified by:

getMessage in interface SingleMessageContainer<T extends Message>

Returns:

the contained message or null if not present or an error occurred while getting the message.

getNumberOfMessages

int getNumberOfMessages()

Returns the number of contained messages.

Returns:

the number of messages.

getMessages

List<T> getMessages()

Returns all the contained messages or an empty List if none.

No assumptions should be made on the actual implementation type of the List returned by this method (for example, it might be unmodifiable or its elements lazy loaded).

Note: Extra care should be taken when getting the messages from the list since it might return null which indicates that an error occurred while getting a message (for example, failed to read a persisted message).

Returns:

a List with all the contained messages, never null.