Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Notifier |
|
| 1.0666666666666667;1,067 |
1 | /* | |
2 | =================== DO NOT EDIT THIS FILE ==================== | |
3 | Generated by Modello 1.0.1 on 2009-03-28 16:09:53, | |
4 | any modifications will be overwritten. | |
5 | ============================================================== | |
6 | */ | |
7 | ||
8 | package org.apache.maven.model; | |
9 | ||
10 | /** | |
11 | * Configures one method for notifying users/developers when a | |
12 | * build breaks. | |
13 | * | |
14 | * @version $Revision$ $Date$ | |
15 | */ | |
16 | 4 | public class Notifier |
17 | implements java.io.Serializable | |
18 | { | |
19 | ||
20 | //--------------------------/ | |
21 | //- Class/Member Variables -/ | |
22 | //--------------------------/ | |
23 | ||
24 | /** | |
25 | * The mechanism used to deliver notifications. | |
26 | */ | |
27 | 4 | private String type = "mail"; |
28 | ||
29 | /** | |
30 | * Whether to send notifications on error. | |
31 | */ | |
32 | 4 | private boolean sendOnError = true; |
33 | ||
34 | /** | |
35 | * Whether to send notifications on failure. | |
36 | */ | |
37 | 4 | private boolean sendOnFailure = true; |
38 | ||
39 | /** | |
40 | * Whether to send notifications on success. | |
41 | */ | |
42 | 4 | private boolean sendOnSuccess = true; |
43 | ||
44 | /** | |
45 | * Whether to send notifications on warning. | |
46 | */ | |
47 | 4 | private boolean sendOnWarning = true; |
48 | ||
49 | /** | |
50 | * | |
51 | * | |
52 | * <b>Deprecated</b>. Where to send the | |
53 | * notification to - eg email address. | |
54 | * | |
55 | * | |
56 | */ | |
57 | private String address; | |
58 | ||
59 | /** | |
60 | * Field configuration. | |
61 | */ | |
62 | private java.util.Properties configuration; | |
63 | ||
64 | ||
65 | //-----------/ | |
66 | //- Methods -/ | |
67 | //-----------/ | |
68 | ||
69 | /** | |
70 | * Method addConfiguration. | |
71 | * | |
72 | * @param key | |
73 | * @param value | |
74 | */ | |
75 | public void addConfiguration( String key, String value ) | |
76 | { | |
77 | 0 | getConfiguration().put( key, value ); |
78 | 0 | } //-- void addConfiguration( String, String ) |
79 | ||
80 | /** | |
81 | * Get <b>Deprecated</b>. Where to send the notification to - | |
82 | * eg email address. | |
83 | * | |
84 | * @return String | |
85 | */ | |
86 | public String getAddress() | |
87 | { | |
88 | 0 | return this.address; |
89 | } //-- String getAddress() | |
90 | ||
91 | /** | |
92 | * Method getConfiguration. | |
93 | * | |
94 | * @return Properties | |
95 | */ | |
96 | public java.util.Properties getConfiguration() | |
97 | { | |
98 | 0 | if ( this.configuration == null ) |
99 | { | |
100 | 0 | this.configuration = new java.util.Properties(); |
101 | } | |
102 | ||
103 | 0 | return this.configuration; |
104 | } //-- java.util.Properties getConfiguration() | |
105 | ||
106 | /** | |
107 | * Get the mechanism used to deliver notifications. | |
108 | * | |
109 | * @return String | |
110 | */ | |
111 | public String getType() | |
112 | { | |
113 | 0 | return this.type; |
114 | } //-- String getType() | |
115 | ||
116 | /** | |
117 | * Get whether to send notifications on error. | |
118 | * | |
119 | * @return boolean | |
120 | */ | |
121 | public boolean isSendOnError() | |
122 | { | |
123 | 0 | return this.sendOnError; |
124 | } //-- boolean isSendOnError() | |
125 | ||
126 | /** | |
127 | * Get whether to send notifications on failure. | |
128 | * | |
129 | * @return boolean | |
130 | */ | |
131 | public boolean isSendOnFailure() | |
132 | { | |
133 | 0 | return this.sendOnFailure; |
134 | } //-- boolean isSendOnFailure() | |
135 | ||
136 | /** | |
137 | * Get whether to send notifications on success. | |
138 | * | |
139 | * @return boolean | |
140 | */ | |
141 | public boolean isSendOnSuccess() | |
142 | { | |
143 | 0 | return this.sendOnSuccess; |
144 | } //-- boolean isSendOnSuccess() | |
145 | ||
146 | /** | |
147 | * Get whether to send notifications on warning. | |
148 | * | |
149 | * @return boolean | |
150 | */ | |
151 | public boolean isSendOnWarning() | |
152 | { | |
153 | 0 | return this.sendOnWarning; |
154 | } //-- boolean isSendOnWarning() | |
155 | ||
156 | /** | |
157 | * Set <b>Deprecated</b>. Where to send the notification to - | |
158 | * eg email address. | |
159 | * | |
160 | * @param address | |
161 | */ | |
162 | public void setAddress( String address ) | |
163 | { | |
164 | 0 | this.address = address; |
165 | 0 | } //-- void setAddress( String ) |
166 | ||
167 | /** | |
168 | * Set extended configuration specific to this notifier goes | |
169 | * here. | |
170 | * | |
171 | * @param configuration | |
172 | */ | |
173 | public void setConfiguration( java.util.Properties configuration ) | |
174 | { | |
175 | 0 | this.configuration = configuration; |
176 | 0 | } //-- void setConfiguration( java.util.Properties ) |
177 | ||
178 | /** | |
179 | * Set whether to send notifications on error. | |
180 | * | |
181 | * @param sendOnError | |
182 | */ | |
183 | public void setSendOnError( boolean sendOnError ) | |
184 | { | |
185 | 0 | this.sendOnError = sendOnError; |
186 | 0 | } //-- void setSendOnError( boolean ) |
187 | ||
188 | /** | |
189 | * Set whether to send notifications on failure. | |
190 | * | |
191 | * @param sendOnFailure | |
192 | */ | |
193 | public void setSendOnFailure( boolean sendOnFailure ) | |
194 | { | |
195 | 0 | this.sendOnFailure = sendOnFailure; |
196 | 0 | } //-- void setSendOnFailure( boolean ) |
197 | ||
198 | /** | |
199 | * Set whether to send notifications on success. | |
200 | * | |
201 | * @param sendOnSuccess | |
202 | */ | |
203 | public void setSendOnSuccess( boolean sendOnSuccess ) | |
204 | { | |
205 | 0 | this.sendOnSuccess = sendOnSuccess; |
206 | 0 | } //-- void setSendOnSuccess( boolean ) |
207 | ||
208 | /** | |
209 | * Set whether to send notifications on warning. | |
210 | * | |
211 | * @param sendOnWarning | |
212 | */ | |
213 | public void setSendOnWarning( boolean sendOnWarning ) | |
214 | { | |
215 | 0 | this.sendOnWarning = sendOnWarning; |
216 | 0 | } //-- void setSendOnWarning( boolean ) |
217 | ||
218 | /** | |
219 | * Set the mechanism used to deliver notifications. | |
220 | * | |
221 | * @param type | |
222 | */ | |
223 | public void setType( String type ) | |
224 | { | |
225 | 0 | this.type = type; |
226 | 0 | } //-- void setType( String ) |
227 | ||
228 | ||
229 | } |