com.atlassian.messagequeue

Class MessageValidatorKey

java.lang.Object

com.atlassian.messagequeue.MessageValidatorKey

All Implemented Interfaces:

Serializable, Comparable<MessageValidatorKey>

@PublicApi
public final class MessageValidatorKey
extends Object
implements Serializable, Comparable<MessageValidatorKey>

Message validator key

Since:

1.0.6

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(MessageValidatorKey o)
boolean	equals(Object o)
int	hashCode()
static MessageValidatorKey	of(String key) Wraps the provided string as a MessageValidatorKey.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static MessageValidatorKey of(String key)

Wraps the provided string as a MessageValidatorKey.

Although it is not necessary for correctness, it will usually make sense to create a single instance of the MessageValidatorKey and reuse it as a constant, as in:

 
     private static final MessageValidatorKey <strong>MY_MESSAGE_VALIDATOR</strong> = MessageValidatorKey.of("com.example.plugin.MyMessageValidator");

     // ...

     private void registerMessageValidator()
     {
         messageValidatorRegistryService.registerMessageValidator(MY_MESSAGE_VALIDATOR, new MyMessageValidatorImpl();
     }
 
 

Parameters:

key - the message validator key, as a string

Returns:

the wrapped message validator key

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(MessageValidatorKey o)

Specified by:

compareTo in interface Comparable<MessageValidatorKey>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object