Package com.eventstore.dbclient

Class SubscriptionFilterBuilder

java.lang.Object

com.eventstore.dbclient.SubscriptionFilterBuilder

public class SubscriptionFilterBuilder
extends java.lang.Object

Utility class for building a subscription filter.

Method Summary

Modifier and Type	Method	Description
SubscriptionFilterBuilder	addEventTypePrefix(@NotNull java.lang.String prefix)	A string prefix to filter events based on their type.
SubscriptionFilterBuilder	addStreamNamePrefix(@NotNull java.lang.String prefix)	A string prefix to filter events based on their stream name.
SubscriptionFilter	build()	Returns a configured subscription filter.
SubscriptionFilterBuilder	withCheckpointer(@NotNull Checkpointer checkpointer)	Calls a callback everytime a checkpoint is reached.
SubscriptionFilterBuilder	withCheckpointer(@NotNull Checkpointer checkpointer, int intervalMultiplierUnsigned)	Calls a callback everytime a checkpoint is reached.
SubscriptionFilterBuilder	withEventTypeRegularExpression(@NotNull java.lang.String pattern)	A regex to filter events based on their type.
SubscriptionFilterBuilder	withMaxWindow(int maxWindow)	The maximum number of events that are filtered out before the page is returned.
SubscriptionFilterBuilder	withStreamNameRegularExpression(@NotNull java.lang.String pattern)	A regex to filter events based on their stream name.

Methods inherited from class java.lang.Object

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

Method Detail

withMaxWindow

public SubscriptionFilterBuilder withMaxWindow(int maxWindow)

The maximum number of events that are filtered out before the page is returned. Must be greater than 0, if supplied.

withStreamNameRegularExpression

public SubscriptionFilterBuilder withStreamNameRegularExpression(@NotNull
                                                                 @NotNull java.lang.String pattern)

A regex to filter events based on their stream name.

addStreamNamePrefix

public SubscriptionFilterBuilder addStreamNamePrefix(@NotNull
                                                     @NotNull java.lang.String prefix)

A string prefix to filter events based on their stream name.

withEventTypeRegularExpression

public SubscriptionFilterBuilder withEventTypeRegularExpression(@NotNull
                                                                @NotNull java.lang.String pattern)

A regex to filter events based on their type.

addEventTypePrefix

public SubscriptionFilterBuilder addEventTypePrefix(@NotNull
                                                    @NotNull java.lang.String prefix)

A string prefix to filter events based on their type.

withCheckpointer

public SubscriptionFilterBuilder withCheckpointer(@NotNull
                                                  @NotNull Checkpointer checkpointer,
                                                  int intervalMultiplierUnsigned)

Calls a callback everytime a checkpoint is reached.

Parameters:

checkpointer - a callback.

intervalMultiplierUnsigned - defines how often this callback is called.

withCheckpointer

public SubscriptionFilterBuilder withCheckpointer(@NotNull
                                                  @NotNull Checkpointer checkpointer)

Calls a callback everytime a checkpoint is reached.

Parameters:

checkpointer - a callback.

build

public SubscriptionFilter build()

Returns a configured subscription filter.

Returns: