org.xwiki.eventstream

Interface EventSearchResult

All Superinterfaces:

AutoCloseable

@Unstable
public interface EventSearchResult
extends AutoCloseable

The result of a search in the EventStore.

Since:

12.4RC1

Version:

$Id: ae2674c1d1d515f8307fb6a42c1d6b7aad4505a4 $

Field Summary

Fields

Modifier and Type	Field and Description
static EventSearchResult	EMPTY An empty instance of EventSearchResult.

Method Summary

Modifier and Type	Method and Description
long	getOffset()
long	getSize()
long	getTotalHits()
Stream<Event>	stream()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

EMPTY

static final EventSearchResult EMPTY

An empty instance of EventSearchResult.

Method Detail

getTotalHits

long getTotalHits()

Returns:

the total number of possible results without offset or maximum results limits

getOffset

long getOffset()

Returns:

the index in the total number of possible search result where this extract starts

getSize

long getSize()

Returns:

the number of found events

stream

Stream<Event> stream()

Returns:

a Stream containing the found events