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

MockListener()

Method Summary

String[]	getAcceptedParams() Get a list of the parameters for this listener.
String	getDescription() A textual description of the listener.
Object	getParam(String s)
void	init(Map params) Initialise the listener.
boolean	isInternal() Indicates whether administrators can delete this listener from within the web interface.
boolean	isUnique() Whether this listener class should be unique.

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

Initialise the listener.

For custom listeners, the list of parameters is always empty.

Specified by:

init in interface JiraListener

Parameters:

params - initialisation parameters

getAcceptedParams

public String[] getAcceptedParams()

Description copied from interface: JiraListener

Get a list of the parameters for this listener.

Specified by:

getAcceptedParams in interface JiraListener

Returns:

list of the parameters for this listener.

isInternal

public boolean isInternal()

Description copied from interface: JiraListener

Indicates whether administrators can delete this listener from within the web interface.

Basically only Atlassian listeners should return true from this.

Specified by:

isInternal in interface JiraListener

Returns:

true if this is an Internal Listener.

isUnique

public boolean isUnique()

Description copied from interface: JiraListener

Whether this listener class should be unique. Some listeners are fine to have multiples, and some are not.

Having multiple mail listeners could be fine - if you wanted multiple mails sent out.

With other listeners, such as the cache listeners, it makes no sense to have multiple listeners of the one class.

Specified by:

isUnique in interface JiraListener

Returns:

Whether this listener class should be unique.

getDescription

public String getDescription()

Description copied from interface: JiraListener

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 / frames.

A good description will describe what this listener does, and then explains the parameters required for configuring the listener.

If no description is appropriate, return null.

Specified by:

getDescription in interface JiraListener

Returns:

A HTML description of the listener

getParam

public Object getParam(String s)