com.dxfeed.model

Class IndexedEventTxModel.Builder<E extends IndexedEvent<?>>

java.lang.Object

com.dxfeed.model.IndexedEventTxModel.Builder<E>

Type Parameters:

E - the type of indexed events processed by the model being created.

Enclosing class:

IndexedEventTxModel<E extends IndexedEvent<?>>

public static final class IndexedEventTxModel.Builder<E extends IndexedEvent<?>>
extends Object

Builder class for IndexedEventTxModel.

Constructor Summary

Constructors

Constructor and Description
Builder(Class<E> eventType) Constructs a new builder for the specified event type.

Method Summary

Modifier and Type	Method and Description
IndexedEventTxModel<E>	build() Builds a new instance of IndexedEventTxModel with the provided configuration.
IndexedEventTxModel.Builder<E>	withAggregationPeriod(com.devexperts.util.TimePeriod aggregationPeriod) Sets the aggregation period for data that limits the rate of data notifications.
IndexedEventTxModel.Builder<E>	withEventsBatchLimit(int eventsBatchLimit) Sets maximum number of events in the single notification of eventsReceived.
IndexedEventTxModel.Builder<E>	withExecutor(Executor executor) Sets the executor for processing listener notifications.
IndexedEventTxModel.Builder<E>	withFeed(DXFeed feed) Sets the feed for the model being created.
IndexedEventTxModel.Builder<E>	withListener(IndexedEventTxModel.Listener<E> listener) Sets the listener for transaction notifications.
IndexedEventTxModel.Builder<E>	withSource(IndexedEventSource source) Sets the source to subscribe to.
IndexedEventTxModel.Builder<E>	withSymbol(IndexedEventSubscriptionSymbol<?> symbol) Sets the subscription symbol and its source for the model being created.
IndexedEventTxModel.Builder<E>	withSymbol(String symbol) Sets the subscription symbol for the model being created.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Class<E> eventType)

Constructs a new builder for the specified event type.

Parameters:

eventType - the class type of indexed event.

Method Detail

withFeed

public IndexedEventTxModel.Builder<E> withFeed(DXFeed feed)

Sets the feed for the model being created.

The feed can also be attached later, after the model has been built using the subscription controller.

Parameters:

feed - the feed.

Returns:

this builder.

withSymbol

public IndexedEventTxModel.Builder<E> withSymbol(IndexedEventSubscriptionSymbol<?> symbol)

Sets the subscription symbol and its source for the model being created.

This symbol and source cannot be added or changed after the model has been built.

Parameters:

symbol - the subscription symbol.

Returns:

this builder.

See Also:

withSymbol(String), withSource(IndexedEventSource)

withSymbol

public IndexedEventTxModel.Builder<E> withSymbol(String symbol)

Sets the subscription symbol for the model being created.

The symbol cannot be added or changed after the model has been built.

Parameters:

symbol - the subscription symbol.

Returns:

this builder.

withSource

public IndexedEventTxModel.Builder<E> withSource(IndexedEventSource source)

Sets the source to subscribe to.

Use the DEFAULT value for source with events that do not have multiple sources (like Series). For events with multiple sources (like Order, AnalyticOrder, OtcMarketsOrder and SpreadOrder), use an event-specific source class (for example, OrderSource).

The source cannot be added or changed after the model has been built.

Parameters:

source - the specified source.

Returns:

this builder.

withListener

public IndexedEventTxModel.Builder<E> withListener(IndexedEventTxModel.Listener<E> listener)

Sets the listener for transaction notifications. The notification is invoked from a separate thread via the executor.

The listener cannot be added or changed after the model has been built.

Parameters:

listener - the model listener.

Returns:

this builder.

withEventsBatchLimit

public IndexedEventTxModel.Builder<E> withEventsBatchLimit(int eventsBatchLimit)

Sets maximum number of events in the single notification of eventsReceived.

This value can be exceeded if the size of the received transaction exceeds the set limit.

This value can be change later, after the model has been built using the subscription controller.

Parameters:

eventsBatchLimit - the notification events limit.

withAggregationPeriod

public IndexedEventTxModel.Builder<E> withAggregationPeriod(com.devexperts.util.TimePeriod aggregationPeriod)

Sets the aggregation period for data that limits the rate of data notifications. For example, setting the value to "0.1s" limits notification to once every 100ms (at most 10 per second).

This value can be change later, after the model has been built using the subscription controller.

Parameters:

aggregationPeriod - the aggregation period for data.

withExecutor

public IndexedEventTxModel.Builder<E> withExecutor(Executor executor)

Sets the executor for processing listener notifications.

Default executor for all models is configured with DXEndpoint.executor method.

This executor can be change later, after the model has been built using the subscription controller.

Parameters:

executor - the executor instance.

Returns:

this builder.

build

public IndexedEventTxModel<E> build()

Builds a new instance of IndexedEventTxModel with the provided configuration.

Returns:

the created model.