org.axonframework.eventsourcing.snapshotting

Class RevisionSnapshotFilter

java.lang.Object

org.axonframework.eventsourcing.snapshotting.RevisionSnapshotFilter

All Implemented Interfaces:

Predicate<DomainEventData<?>>, SnapshotFilter

public class RevisionSnapshotFilter
extends Object
implements SnapshotFilter

A SnapshotFilter implementation which based on a configurable allowed revision will only SnapshotFilter.allow(DomainEventData) DomainEventData containing that revision. True will also be returned if the DomainEventData.getType() does not match the given type, as in compliance with the SnapshotFilter documentation.

Since:

4.5

Author:

Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RevisionSnapshotFilter.Builder Builder class to instantiate a RevisionSnapshotFilter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RevisionSnapshotFilter(RevisionSnapshotFilter.Builder builder) Instantiate a RevisionSnapshotFilter based on the fields contained in the RevisionSnapshotFilter.Builder.
	RevisionSnapshotFilter(String allowedRevision) Deprecated. in favor of using the RevisionSnapshotFilter.Builder

Method Summary

Modifier and Type	Method and Description
static RevisionSnapshotFilter.Builder	builder() Instantiate a Builder to be able to create a RevisionSnapshotFilter.
boolean	test(DomainEventData<?> domainEventData)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.eventsourcing.snapshotting.SnapshotFilter

allow, allowAll, combine, rejectAll

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

RevisionSnapshotFilter

protected RevisionSnapshotFilter(RevisionSnapshotFilter.Builder builder)

Instantiate a RevisionSnapshotFilter based on the fields contained in the RevisionSnapshotFilter.Builder.

Will assert that the type is not null or an empty String and the revision is not an empty String and will throw an AxonConfigurationException if this is the case.

Parameters:

builder - the RevisionSnapshotFilter.Builder used to instantiate a RevisionSnapshotFilter instance

RevisionSnapshotFilter

@Deprecated
public RevisionSnapshotFilter(String allowedRevision)

Deprecated. in favor of using the RevisionSnapshotFilter.Builder

Construct a RevisionSnapshotFilter which returns true on SnapshotFilter.allow(DomainEventData) invocations where the DomainEventData contains the given revision.

Parameters:

allowedRevision - the revision which is allowed by this SnapshotFilter

Method Detail

builder

public static RevisionSnapshotFilter.Builder builder()

Instantiate a Builder to be able to create a RevisionSnapshotFilter.

The type is hard requirements and as such should be provided. The revision should not be an empty String

Returns:

a Builder to be able to create a RevisionSnapshotFilter

test

public boolean test(DomainEventData<?> domainEventData)

Specified by:

test in interface Predicate<DomainEventData<?>>