Package com.vaadin.flow.server.data

Class DataCountEndedEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.server.data.AbstractDataCountEvent

com.vaadin.flow.server.data.DataCountEndedEvent

All Implemented Interfaces:

Serializable

public class DataCountEndedEvent
extends AbstractDataCountEvent

Event fired through the service event bus once a count query has returned or thrown, on the thread that issued it.

Fired in reverse listener registration order, so that listeners nest around the matching DataCountStartedEvent. It is fired whether the query returned normally or threw, so a listener can clean up its timing state in one place.

Since:

25.3

See Also:

• AbstractDataCountEvent
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
DataCountEndedEvent(UI ui, Component component, boolean filtered, int count)	Creates a new event.

Method Summary

Modifier and Type	Method	Description
int	getCount()	Gets the number of items the data provider reported.

Methods inherited from class com.vaadin.flow.server.data.AbstractDataCountEvent

getComponent, getSource, getUI, isFiltered

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Details

DataCountEndedEvent

public DataCountEndedEvent(UI ui,
 Component component,
 boolean filtered,
 int count)

Creates a new event.

Parameters:

ui - the UI the counting component belongs to, not null

component - the component whose data is being counted, or null if it could not be resolved

filtered - whether a filter was set on the query

count - the number of items the data provider reported, or -1 if the query threw, in which case a DataCountFailedEvent carrying the throwable was fired first

Method Details

getCount

public int getCount()

Gets the number of items the data provider reported.

Returns:

the count, or -1 if the query threw