Package org.axonframework.eventsourcing

Class AbstractSnapshotter.Builder

java.lang.Object

org.axonframework.eventsourcing.AbstractSnapshotter.Builder

Direct Known Subclasses:

AggregateSnapshotter.Builder

Enclosing class:

AbstractSnapshotter

public abstract static class AbstractSnapshotter.Builder
extends Object

Abstract Builder class to instantiate AbstractSnapshotter implementations.

The Executor is defaulted to an DirectExecutor.INSTANCE, the TransactionManager defaults to a NoTransactionManager, and the SnapshotterSpanFactory defaults to a DefaultSnapshotterSpanFactory with a NoOpSpanFactory delegate. The EventStore is a hard requirement and as such should be provided.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AbstractSnapshotter.Builder	eventStore(EventStore eventStore)	Sets the EventStore instance which this AbstractSnapshotter implementation will store snapshots in.
AbstractSnapshotter.Builder	executor(Executor executor)	Sets the Executor which handles the actual snapshot creation process.
AbstractSnapshotter.Builder	spanFactory(SnapshotterSpanFactory spanFactory)	Sets the SnapshotterSpanFactory implementation to use for providing tracing capabilities.
AbstractSnapshotter.Builder	spanFactory(SpanFactory spanFactory)	Deprecated. Use spanFactory(SnapshotterSpanFactory) instead as it provides more configurability.
AbstractSnapshotter.Builder	transactionManager(TransactionManager transactionManager)	Sets the TransactionManager used to manage the transaction around storing the snapshot.
protected void	validate()	Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

eventStore

public AbstractSnapshotter.Builder eventStore(EventStore eventStore)

Sets the EventStore instance which this AbstractSnapshotter implementation will store snapshots in.

Parameters:

eventStore - the EventStore instance which this AbstractSnapshotter implementation will store snapshots in

Returns:

the current Builder instance, for fluent interfacing

executor

public AbstractSnapshotter.Builder executor(Executor executor)

Sets the Executor which handles the actual snapshot creation process. Defaults to a DirectExecutor.

Parameters:

executor - an Executor which handles the actual snapshot creation process

Returns:

the current Builder instance, for fluent interfacing

spanFactory

@Deprecated
public AbstractSnapshotter.Builder spanFactory(@Nonnull
 SpanFactory spanFactory)

Deprecated.

Use spanFactory(SnapshotterSpanFactory) instead as it provides more configurability.

Sets the SpanFactory implementation to use for providing tracing capabilities. Defaults to a NoOpSpanFactory by default, which provides no tracing capabilities.

Parameters:

spanFactory - The SpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

public AbstractSnapshotter.Builder spanFactory(@Nonnull
 SnapshotterSpanFactory spanFactory)

Sets the SnapshotterSpanFactory implementation to use for providing tracing capabilities. Defaults to a DefaultSnapshotterSpanFactory with a NoOpSpanFactory by default, which provides no tracing capabilities.

Parameters:

spanFactory - The SpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

transactionManager

public AbstractSnapshotter.Builder transactionManager(TransactionManager transactionManager)

Sets the TransactionManager used to manage the transaction around storing the snapshot. Defaults to a NoTransactionManager.

Parameters:

transactionManager - the TransactionManager used to manage the transaction around storing the snapshot

Returns:

the current Builder instance, for fluent interfacing

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications