Package org.axonframework.test.fixture

Record Class AxonTestFixture.Customization

java.lang.Object

java.lang.Record

org.axonframework.test.fixture.AxonTestFixture.Customization

Record Components:

axonServerEnabled - True if Axon Server should be enabled, false otherwise. It's enabled by default.

fieldFilters - Collections of FieldFilters used to adjust the matchers for commands, events, and result messages.

Enclosing class:

AxonTestFixture

public static record AxonTestFixture.Customization(boolean axonServerEnabled, @Nonnull List<FieldFilter> fieldFilters)
extends Record

Allow customizing the fixture setup.

Constructor Summary

Constructors

Constructor	Description
Customization()	Creates a new instance of Customization.
Customization(boolean axonServerEnabled, List<FieldFilter> fieldFilters)	Creates an instance of a Customization record class.

Method Summary

Modifier and Type	Method	Description
boolean	axonServerDisabled()	Indicates whether Axon Server is disabled.
boolean	axonServerEnabled()	Indicates whether Axon Server is enabled.
AxonTestFixture.Customization	disableAxonServer()	Configures Axon Server to be disabled.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<FieldFilter>	fieldFilters()	Configured field filters.
final int	hashCode()	Returns a hash code value for this object.
AxonTestFixture.Customization	registerFieldFilter(FieldFilter fieldFilter)	Registers the given fieldFilter, which is used to define which Fields are used when comparing objects.
AxonTestFixture.Customization	registerIgnoredField(Class<?> declaringClass, String fieldName)	Indicates that a field with given fieldName, which is declared in given declaringClass is ignored when performing deep equality checks.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Customization

public Customization()

Creates a new instance of Customization.

Customization

public Customization(boolean axonServerEnabled,
 @Nonnull
 List<FieldFilter> fieldFilters)

Creates an instance of a Customization record class.

Parameters:

axonServerEnabled - the value for the axonServerEnabled record component

fieldFilters - the value for the fieldFilters record component

Method Details

registerFieldFilter

public AxonTestFixture.Customization registerFieldFilter(@Nonnull
 FieldFilter fieldFilter)

Registers the given fieldFilter, which is used to define which Fields are used when comparing objects.

This filter is used by the following methods:

• AxonTestPhase.Then.MessageAssertions.events(java.lang.Object...)
• AxonTestPhase.Then.MessageAssertions.commands(java.lang.Object...)
• AxonTestPhase.Then.Command.resultMessagePayload(java.lang.Object)

If you use custom assertions with methods like AxonTestPhase.Then.MessageAssertions.eventsSatisfy(java.util.function.Consumer<java.util.List<org.axonframework.messaging.eventhandling.EventMessage>>) or AxonTestPhase.Then.MessageAssertions.eventsMatch(java.util.function.Predicate<java.util.List<org.axonframework.messaging.eventhandling.EventMessage>>) this filter is not taken into account.

When multiple filters are registered, a Field must be accepted by all registered filters in order to be accepted.

By default, all Fields are included in the comparison.

Parameters:

fieldFilter - The FieldFilter that defines which fields to include in the comparison.

Returns:

the current Customization, for fluent interfacing.

registerIgnoredField

public AxonTestFixture.Customization registerIgnoredField(@Nonnull
 Class<?> declaringClass,
 @Nonnull
 String fieldName)

Indicates that a field with given fieldName, which is declared in given declaringClass is ignored when performing deep equality checks.

This filter is used by the following methods:

• AxonTestPhase.Then.MessageAssertions.events(java.lang.Object...)
• AxonTestPhase.Then.MessageAssertions.commands(java.lang.Object...)
• AxonTestPhase.Then.Command.resultMessagePayload(java.lang.Object)

If you use custom assertions with methods like AxonTestPhase.Then.MessageAssertions.eventsSatisfy(java.util.function.Consumer<java.util.List<org.axonframework.messaging.eventhandling.EventMessage>>) or AxonTestPhase.Then.MessageAssertions.eventsMatch(java.util.function.Predicate<java.util.List<org.axonframework.messaging.eventhandling.EventMessage>>) this filter is not taken into account.

Parameters:

declaringClass - The class declaring the field.

fieldName - The name of the field.

Returns:

the current Customization, for fluent interfacing

Throws:

FixtureExecutionException - when no such field is declared

fieldFilters

public List<FieldFilter> fieldFilters()

Configured field filters.

Returns:

The list of field filters.

disableAxonServer

public AxonTestFixture.Customization disableAxonServer()

Configures Axon Server to be disabled.

Returns:

The current Customization, for fluent interfacing.

axonServerEnabled

public boolean axonServerEnabled()

Indicates whether Axon Server is enabled.

Returns:

True if Axon Server is enabled, false otherwise.

axonServerDisabled

public boolean axonServerDisabled()

Indicates whether Axon Server is disabled.

Returns:

True if Axon Server is disabled, false otherwise.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.