org.sonar.api.notifications

Class NotificationDispatcherMetadata

java.lang.Object

org.sonar.api.notifications.NotificationDispatcherMetadata

All Implemented Interfaces:

Extension, ServerComponent, ServerExtension

public final class NotificationDispatcherMetadata
extends Object
implements ServerExtension

Notification dispatchers (see NotificationDispatcher) can define their own metadata class in order to tell more about them.
Instances of those classes must be passed to Pico container (generally in the SonarPlugin#getExtensions() method implementation).

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOBAL_NOTIFICATION
static String	PER_PROJECT_NOTIFICATION

Method Summary

Methods

Modifier and Type	Method and Description
static NotificationDispatcherMetadata	create(String dispatcherKey) Creates a new metadata instance for the given dispatcher.
String	getDispatcherKey() Returns the unique key of the dispatcher.
String	getProperty(String key) Gives the property for the given key.
NotificationDispatcherMetadata	setProperty(String key, String value) Sets a property on this metadata object.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_NOTIFICATION

public static final String GLOBAL_NOTIFICATION

See Also:

Constant Field Values

PER_PROJECT_NOTIFICATION

public static final String PER_PROJECT_NOTIFICATION

See Also:

Constant Field Values

Method Detail

create

public static NotificationDispatcherMetadata create(String dispatcherKey)

Creates a new metadata instance for the given dispatcher.

setProperty

public NotificationDispatcherMetadata setProperty(String key,
                                         String value)

Sets a property on this metadata object.

getProperty

public String getProperty(String key)

Gives the property for the given key.

getDispatcherKey

public String getDispatcherKey()

Returns the unique key of the dispatcher.