Package com.vaadin.flow.component.notification

Class NotificationTester<T extends Notification>

java.lang.Object

com.vaadin.testbench.unit.ComponentTester<T>

com.vaadin.flow.component.notification.NotificationTester<T>

Type Parameters:

T - component type

public class NotificationTester<T extends Notification>
extends ComponentTester<T>

Tester for Notification components.

Constructor Summary

Constructors

Constructor	Description
NotificationTester(T component)	Wrap given component for testing.

Method Summary

Modifier and Type	Method	Description
void	autoClose()	Simulates auto-close of the notification, because of show duration timeout.
String	getText()	Gets the text of the notification.
boolean	isUsable()	Validate that component can be interacted with and should be visible in the UI.
protected void	notUsableReasons(Consumer<String> collector)	Provides messages explaining why the component is actually not usable.

Methods inherited from class com.vaadin.testbench.unit.ComponentTester

ensureComponentIsUsable, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, roundTrip, setModal

Methods inherited from class java.lang.Object

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

Constructor Details

NotificationTester

public NotificationTester(T component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

getText

public String getText()

Gets the text of the notification. If the notification is not displayed an IllegalStateException will be thrown as the end user would not be able to see the contents.

Returns:

the text of the notification

Throws:

IllegalStateException - is notification is not displayed

autoClose

public void autoClose()

Simulates auto-close of the notification, because of show duration timeout. If notification is not displayed or auto-close is disabled setting duration to 0 or negative, an IllegalStateException is thrown.

Throws:

IllegalStateException - if the notification is not displayed or has auto-close disabled.

isUsable

public boolean isUsable()

Description copied from class: ComponentTester

Validate that component can be interacted with and should be visible in the UI. Subclasses overriding this method should also override ComponentTester.notUsableReasons(Consumer) to provide additional details to the potential exception thrown by ComponentTester.ensureComponentIsUsable().

Overrides:

isUsable in class ComponentTester<T extends Notification>

Returns:

true if component can be interacted with by the user

See Also:

• ComponentTester.notUsableReasons(Consumer)
• ComponentTester.ensureComponentIsUsable()

notUsableReasons

protected void notUsableReasons(Consumer<String> collector)

Description copied from class: ComponentTester

Provides messages explaining why the component is actually not usable. Subclasses overriding ComponentTester.isUsable() should also override this method to provide additional details to the potential exception throw by ComponentTester.ensureComponentIsUsable().

Overrides:

notUsableReasons in class ComponentTester<T extends Notification>

See Also:

• ComponentTester.isUsable()
• ComponentTester.ensureComponentIsUsable()