org.axonframework.commandhandling.distributed.commandfilter

Class CommandNameFilter

java.lang.Object

org.axonframework.commandhandling.distributed.commandfilter.CommandNameFilter

All Implemented Interfaces:

Serializable, CommandMessageFilter

public class CommandNameFilter
extends Object
implements CommandMessageFilter

A filter for CommandMessages which filters CommandMessages by a Command Name. It can be combined with other CommandNameFilters in an efficient manner.

Author:

Koen Lavooij

See Also:

Serialized Form

Constructor Summary

Constructors

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

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	negate() Returns a filter that matches when this instance doesn't, and vice versa.
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

Constructor Detail

CommandNameFilter

public CommandNameFilter(Set<String> commandNames)

Initializes a CommandNameFilter for the given set of commandNames.

Parameters:

commandNames - commands that can be handled

CommandNameFilter

public CommandNameFilter(String commandName)

Initializes a CommandNameFilter for a single command name.

Parameters:

commandName - command that can be handled

Method Detail

matches

public boolean matches(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

negate

public CommandMessageFilter negate()

Description copied from interface: CommandMessageFilter

Returns a filter that matches when this instance doesn't, and vice versa.

Specified by:

negate in interface CommandMessageFilter

Returns:

a filter that negates the result of this instance

and

public CommandMessageFilter and(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(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