org.axonframework.commandhandling.distributed.commandfilter

Class DenyCommandNameFilter

java.lang.Object

org.axonframework.commandhandling.distributed.commandfilter.DenyCommandNameFilter

All Implemented Interfaces:

Serializable, CommandMessageFilter

public class DenyCommandNameFilter
extends Object
implements CommandMessageFilter

A CommandMessageFilter implementation which denies CommandMessages based on their CommandMessage.getCommandName(). It can be combined with other CommandMessageFilter instances in an efficient manner.

Since:

3.0

Author:

Koen Lavooij, Allard Buijze

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenyCommandNameFilter(Set<String> commandNames) Initializes a DenyCommandNameFilter from the given set of commandNames.
DenyCommandNameFilter(String commandName) Initializes a DenyCommandNameFilter for a single commandName.

Method Summary

Modifier and Type	Method and Description
CommandMessageFilter	and(CommandMessageFilter other) Returns a filter that matches when both this instance and the given other match.
boolean	equals(Object o)
int	hashCode()
boolean	matches(CommandMessage<?> commandMessage) Indicates whether the given commandMessage matches this filter.
CommandMessageFilter	or(CommandMessageFilter other) Returns a filter that matches when either this instance or the given other matches.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.commandhandling.distributed.CommandMessageFilter

negate

Constructor Detail

DenyCommandNameFilter

@ConstructorProperties(value="commandNames")
public DenyCommandNameFilter(Set<String> commandNames)

Initializes a DenyCommandNameFilter from the given set of commandNames. Commands with a name that is present in this set will be blocked by this filter.

Parameters:

commandNames - the names of commands blocked by this filter

DenyCommandNameFilter

public DenyCommandNameFilter(String commandName)

Initializes a DenyCommandNameFilter for a single commandName. Commands with a name equal to the given commandName will be blocked by this filter.

Parameters:

commandName - the name of the command blocked by this filter

Method Detail

matches

public boolean matches(@Nonnull
                       CommandMessage<?> commandMessage)

Description copied from interface: CommandMessageFilter

Indicates whether the given commandMessage matches this filter.

Specified by:

matches in interface CommandMessageFilter

Parameters:

commandMessage - the message to match

Returns:

true if the command matches, otherwise false

and

public CommandMessageFilter and(@Nonnull
                                CommandMessageFilter other)

Description copied from interface: CommandMessageFilter

Returns a filter that matches when both this instance and the given other match.

Specified by:

and in interface CommandMessageFilter

Parameters:

other - the other filter to match against

Returns:

a filter that matches when both this instance and the other match

or

public CommandMessageFilter or(@Nonnull
                               CommandMessageFilter other)

Description copied from interface: CommandMessageFilter

Returns a filter that matches when either this instance or the given other matches.

Specified by:

or in interface CommandMessageFilter

Parameters:

other - the other filter to match against

Returns:

a filter that matches when either this instance or the other matches

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object