org.axonframework.commandhandling.distributed.commandfilter

Enum DenyAll

java.lang.Object

java.lang.Enum<DenyAll>

org.axonframework.commandhandling.distributed.commandfilter.DenyAll

All Implemented Interfaces:

Serializable, Comparable<DenyAll>, CommandMessageFilter

public enum DenyAll
extends Enum<DenyAll>
implements CommandMessageFilter

A CommandMessageFilter that denies all CommandMessages.

Since:

3.0

Author:

Koen Lavooij

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton instance of the DenyAll filter.

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	matches(CommandMessage<?> message) 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()
static DenyAll	valueOf(String name) Returns the enum constant of this type with the specified name.
static DenyAll[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final DenyAll INSTANCE

Singleton instance of the DenyAll filter.

Method Detail

values

public static DenyAll[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DenyAll c : DenyAll.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DenyAll valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

matches

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

Description copied from interface: CommandMessageFilter

Indicates whether the given commandMessage matches this filter.

Specified by:

matches in interface CommandMessageFilter

Parameters:

message - 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

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

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

toString

public String toString()

Overrides:

toString in class Enum<DenyAll>