com.atlassian.jira.mock.event

Class MockListener

java.lang.Object

com.atlassian.jira.mock.event.MockListener

All Implemented Interfaces:

JiraListener, EventListener

Direct Known Subclasses:

MockIssueEventListener

public class MockListener
extends Object
implements JiraListener

Constructor Summary

Constructors

Constructor and Description
MockListener()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getAcceptedParams() Returns the parameters used by this listener.
String	getDescription() Returns a textual description of the listener.
Object	getParam(String s)
void	init(Map params) Initialises the listener with the given parameters.
boolean	isInternal() Indicates whether this listener is internal, meaning it cannot be removed by an administrator.
boolean	isUnique() Indicates whether JIRA should only create one instance of this listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockListener

public MockListener()

Method Detail

init

public void init(Map params)

Description copied from interface: JiraListener

Initialises the listener with the given parameters.

Specified by:

init in interface JiraListener

Parameters:

params - the initialisation parameters given in the Listener Properties

getAcceptedParams

public String[] getAcceptedParams()

Description copied from interface: JiraListener

Returns the parameters used by this listener.

Specified by:

getAcceptedParams in interface JiraListener

Returns:

a non-null array (can be empty)

isInternal

public boolean isInternal()

Description copied from interface: JiraListener

Indicates whether this listener is internal, meaning it cannot be removed by an administrator.

Specified by:

isInternal in interface JiraListener

Returns:

true if this is an Atlassian listener, otherwise false

isUnique

public boolean isUnique()

Description copied from interface: JiraListener

Indicates whether JIRA should only create one instance of this listener. For example, having multiple mail listeners would be fine if you wanted multiple mails sent out. For other listeners, such as cache listeners, it makes no sense to have multiple instances.

Specified by:

isUnique in interface JiraListener

Returns:

whether this listener should be a singleton

getDescription

public String getDescription()

Description copied from interface: JiraListener

Returns a textual description of the listener. You can include HTML if required, but do not use tables or DHTML, as the description may be displayed inside tables or frames.

A good description will describe what this listener does and explain the parameters required for configuring it.

Specified by:

getDescription in interface JiraListener

Returns:

a description of the listener, or null if no description is appropriate

getParam

public Object getParam(String s)