1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* SonarQube
* Copyright (C) 2009-2017 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.notifications;
import com.google.common.collect.Maps;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.Map;
/**
* This class represents a notification that will be delivered to users. This is a general concept and it has no
* knowledge of the possible ways to be delivered (see {@link NotificationChannel}).
* <p>
* When creating a new notification, it is strongly advised to give a default message that can be used by channels
* that don't want to specifically format messages for different notification types. You can use
* {@link Notification#setDefaultMessage(String)} for that purpose.
*
*
* @since 2.10
*/
public class Notification implements Serializable {
private static final String DEFAULT_MESSAGE_KEY = "default_message";
private final String type;
private final Map<String, String> fields = Maps.newHashMap();
/**
* <p>
* Create a new {@link Notification} of the given type.
*
* Example: type = "new-violations"
*
* @param type the type of notification
*/
public Notification(String type) {
this.type = type;
}
/**
* Returns the type of the notification
*
* @return the type
*/
public String getType() {
return type;
}
/**
* <p>
* When creating a new notification, it is strongly advised to give a default message that can be
* used by channels that don't want to specifically format messages for different notification types.
*
* <p>
* This method is equivalent to setting a value for the field {@link #DEFAULT_MESSAGE_KEY} with
* {@link #setFieldValue(String, String)}.
*
*
* @since 3.5
*/
public Notification setDefaultMessage(String value) {
setFieldValue(DEFAULT_MESSAGE_KEY, value);
return this;
}
/**
* Returns the default message to display for this notification.
*/
public String getDefaultMessage() {
String defaultMessage = getFieldValue(DEFAULT_MESSAGE_KEY);
if (defaultMessage == null) {
defaultMessage = this.toString();
}
return defaultMessage;
}
/**
* Adds a field (kind of property) to the notification
*
* @param field the name of the field (= the key)
* @param value the value of the field
* @return the notification itself
*/
public Notification setFieldValue(String field, @Nullable String value) {
fields.put(field, value);
return this;
}
/**
* Returns the value of a field.
*
* @param field the field
* @return the value of the field
*/
@CheckForNull
public String getFieldValue(String field) {
return fields.get(field);
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Notification)) {
return false;
}
if (this == obj) {
return true;
}
Notification other = (Notification) obj;
return this.type.equals(other.type) && this.fields.equals(other.fields);
}
@Override
public int hashCode() {
return type.hashCode() * 31 + fields.hashCode();
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder("Notification{");
sb.append("type='").append(type).append('\'');
sb.append(", fields=").append(fields);
sb.append('}');
return sb.toString();
}
}
|
