jenkins.plugins.hipchat.model

Class NotificationConfig

java.lang.Object

jenkins.plugins.hipchat.model.NotificationConfig

All Implemented Interfaces:

hudson.model.Describable<NotificationConfig>

public class NotificationConfig
extends Object
implements hudson.model.Describable<NotificationConfig>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationConfig.DescriptorImpl

Constructor Summary

Constructors

Constructor and Description
NotificationConfig(boolean notifyEnabled, boolean textFormat, NotificationType notificationType, Notification.Color color, String icon, String messageTemplate)

Method Summary

Modifier and Type	Method and Description
Notification.Color	getColor()
hudson.model.Descriptor<NotificationConfig>	getDescriptor()
String	getIcon()
Icon	getIconObject()
String	getMessageTemplate()
NotificationType	getNotificationType()
boolean	isNotifyEnabled()
boolean	isTextFormat()
NotificationConfig	overrideMessageTemplate(String messageTemplate) Returns a copy of the notification config that will contain the same settings, but the message template will be overridden with the freshly provided one.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationConfig

@DataBoundConstructor
public NotificationConfig(boolean notifyEnabled,
                                                boolean textFormat,
                                                NotificationType notificationType,
                                                Notification.Color color,
                                                String icon,
                                                String messageTemplate)

Method Detail

isNotifyEnabled

public boolean isNotifyEnabled()

getNotificationType

public NotificationType getNotificationType()

isTextFormat

public boolean isTextFormat()

getColor

public Notification.Color getColor()

getIcon

public String getIcon()

getIconObject

public Icon getIconObject()

getMessageTemplate

public String getMessageTemplate()

overrideMessageTemplate

public NotificationConfig overrideMessageTemplate(String messageTemplate)

Returns a copy of the notification config that will contain the same settings, but the message template will be overridden with the freshly provided one.

Parameters:

messageTemplate - The new message template to use.

Returns:

A new NotificationConfig instance that has its message template updated.

getDescriptor

public hudson.model.Descriptor<NotificationConfig> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<NotificationConfig>

toString

public String toString()

Overrides:

toString in class Object