Package com.vaadin.flow.component.messages

Class MessageListLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<MessageList,MessageListLocator>

com.vaadin.flow.component.messages.MessageListLocator

All Implemented Interfaces:

Clickable<MessageList>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class MessageListLocator
extends Locator<MessageList,MessageListLocator>
implements Clickable<MessageList>

Generated locator for MessageList, derived from MessageListTester. Filter steps are inherited from Locator; action methods delegate to a fresh tester around the resolved component, so behavioral changes belong on the tester, not here.

Constructor Summary

Constructors

Constructor	Description
MessageListLocator()
MessageListLocator(MessageList component)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
MessageList	getComponent()	Gets the component being tested.
MessageListItem	getMessage(int index)	Get message in given index.
List<MessageListItem>	getMessages()	Get all messages in list.
List<MessageListItem>	getMessages(String userName)	Get all messages for a given userName.
List<MessageListItem>	getMessages(Instant start, Instant end)	Get messages between given Instant (excluding).
List<MessageListItem>	getMessagesAfter(Instant start)	Get messages after given Instant (excluding).
List<MessageListItem>	getMessagesBefore(Instant end)	Get messages before given Instant (excluding).
int	size()	Get amount of messages in the messageList.

Methods inherited from class com.vaadin.browserless.locator.Locator

atIndex, component, components, exists, inside, inside, invalidate, self, with, withAttribute, withAttribute, withClassName, withCondition, withId, withoutAttribute, withoutAttribute, withoutClassName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.browserless.Clickable

click, click, click, middleClick, middleClick, rightClick, rightClick

Constructor Details

MessageListLocator

public MessageListLocator()

MessageListLocator

public MessageListLocator(MessageList component)

Method Details

getComponent

public MessageList getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<MessageList>

Returns:

the component under test

ensureComponentIsUsable

public void ensureComponentIsUsable()

Description copied from interface: Clickable

Ensures the component is in a usable state before interaction.

Specified by:

ensureComponentIsUsable in interface Clickable<MessageList>

size

public int size()

Get amount of messages in the messageList. Javadoc copied from MessageListTester.size().

Returns:

message count

getMessage

public MessageListItem getMessage(int index)

Get message in given index. index is 0 based. Javadoc copied from MessageListTester.getMessage(int).

Parameters:

index - item index

Returns:

message in index

Throws:

IndexOutOfBoundsException - – if the index is out of range (index invalid input: '<' 0 || index >= size())

getMessages

public List<MessageListItem> getMessages()

Get all messages in list. Javadoc copied from MessageListTester.getMessages().

Returns:

all available messages

getMessages

public List<MessageListItem> getMessages(Instant start,
 Instant end)

Get messages between given Instant (excluding). Javadoc copied from MessageListTester.getMessages(java.time.Instant,java.time.Instant).

Parameters:

start - start time

end - end time

Returns:

messages falling between start an end time

getMessagesAfter

public List<MessageListItem> getMessagesAfter(Instant start)

Get messages after given Instant (excluding). Javadoc copied from MessageListTester.getMessagesAfter(java.time.Instant).

Parameters:

start - start time

Returns:

messages after start time

getMessagesBefore

public List<MessageListItem> getMessagesBefore(Instant end)

Get messages before given Instant (excluding). Javadoc copied from MessageListTester.getMessagesBefore(java.time.Instant).

Parameters:

end - end time

Returns:

messages before end time

getMessages

public List<MessageListItem> getMessages(String userName)

Get all messages for a given userName. Javadoc copied from MessageListTester.getMessages(java.lang.String).

Parameters:

userName - user to get messages for (nullable)

Returns:

messages for user, for null messages without defined userName