1 package org.apache.maven.shared.io.logging;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * Message Holder class.
24 *
25 */
26 public interface MessageHolder
27 {
28
29 /**
30 * @return {@link MessageHolder}
31 */
32 MessageHolder newMessage();
33
34 /**
35 * @return {@link MessageHolder}
36 */
37 MessageHolder newDebugMessage();
38
39 /**
40 * @return {@link MessageHolder}
41 */
42 MessageHolder newInfoMessage();
43
44 /**
45 * @return {@link MessageHolder}
46 */
47 MessageHolder newWarningMessage();
48
49 /**
50 * @return {@link MessageHolder}
51 */
52 MessageHolder newErrorMessage();
53
54 /**
55 * @return {@link MessageHolder}
56 */
57 MessageHolder newSevereMessage();
58
59 /**
60 * @param messagePart message part.
61 * @return {@link MessageHolder}
62 */
63 MessageHolder append( CharSequence messagePart );
64
65 /**
66 * @param error {@link Throwable}
67 * @return {@link MessageHolder}
68 */
69 MessageHolder append( Throwable error );
70
71 /**
72 * @param messagePart Message Part.
73 * @param error {@link Throwable}
74 * @return {@link MessageHolder}
75 */
76 MessageHolder addMessage( CharSequence messagePart, Throwable error );
77
78 /**
79 * @param messagePart message part.
80 * @return {@link MessageHolder}
81 */
82 MessageHolder addMessage( CharSequence messagePart );
83
84 /**
85 * @param error {@link Throwable}
86 * @return {@link MessageHolder}
87 */
88 MessageHolder addMessage( Throwable error );
89
90 /**
91 * @param messagePart message part.
92 * @param error {@link Throwable}
93 * @return {@link MessageHolder}
94 */
95 MessageHolder addDebugMessage( CharSequence messagePart, Throwable error );
96
97 /**
98 * @param messagePart messages part.
99 * @return {@link MessageHolder}
100 */
101 MessageHolder addDebugMessage( CharSequence messagePart );
102
103 /**
104 * @param error messages part.
105 * @return {@link MessageHolder}
106 */
107 MessageHolder addDebugMessage( Throwable error );
108
109 /**
110 * @param messagePart message part.
111 * @param error {@link Throwable}
112 * @return {@link MessageHolder}
113 */
114 MessageHolder addInfoMessage( CharSequence messagePart, Throwable error );
115
116 /**
117 * @param messagePart messages part.
118 * @return {@link MessageHolder}
119 */
120 MessageHolder addInfoMessage( CharSequence messagePart );
121
122 /**
123 * @param error {@link Throwable}
124 * @return {@link MessageHolder}
125 */
126 MessageHolder addInfoMessage( Throwable error );
127
128 /**
129 * @param messagePart message part.
130 * @param error {@link Throwable}
131 * @return {@link MessageHolder}
132 */
133 MessageHolder addWarningMessage( CharSequence messagePart, Throwable error );
134
135 /**
136 * @param messagePart message part.
137 * @return {@link MessageHolder}
138 */
139 MessageHolder addWarningMessage( CharSequence messagePart );
140
141 /**
142 * @param error {@link Throwable}
143 * @return {@link MessageHolder}
144 */
145 MessageHolder addWarningMessage( Throwable error );
146
147 /**
148 * @param messagePart message part.
149 * @param error {@link Throwable}
150 * @return {@link MessageHolder}
151 */
152 MessageHolder addErrorMessage( CharSequence messagePart, Throwable error );
153
154 /**
155 * @param messagePart message part.
156 * @return {@link MessageHolder}
157 */
158 MessageHolder addErrorMessage( CharSequence messagePart );
159
160 /**
161 * @param error {@link Throwable}
162 * @return {@link MessageHolder}
163 */
164 MessageHolder addErrorMessage( Throwable error );
165
166 /**
167 * @param messagePart message part.
168 * @param error {@link Throwable}
169 * @return {@link MessageHolder}
170 */
171 MessageHolder addSevereMessage( CharSequence messagePart, Throwable error );
172
173 /**
174 * @param messagePart message part.
175 * @return {@link MessageHolder}
176 */
177 MessageHolder addSevereMessage( CharSequence messagePart );
178
179 /**
180 * @param error The error.
181 * @return {@link MessageHolder}
182 */
183 MessageHolder addSevereMessage( Throwable error );
184
185 /**
186 * @return the size.
187 */
188 int size();
189
190 /**
191 * @return count number of messages.
192 */
193 int countMessages();
194
195 /**
196 * @return count number of debug messages.
197 */
198 int countDebugMessages();
199
200 /**
201 * @return count number of info messages.
202 */
203 int countInfoMessages();
204
205 /**
206 * @return count number of warning messages.
207 */
208 int countWarningMessages();
209
210 /**
211 * @return count number of error messages.
212 */
213 int countErrorMessages();
214
215 /**
216 * @return count number of server messages.
217 */
218 int countSevereMessages();
219
220 /**
221 * @return true / false.
222 */
223 boolean isDebugEnabled();
224
225 /**
226 * @param enabled enable debug
227 */
228 void setDebugEnabled( boolean enabled );
229
230 /**
231 * @return true if info is enabled false otherwise.
232 */
233 boolean isInfoEnabled();
234
235 /**
236 * @param enabled true info enable false otherwise.
237 */
238 void setInfoEnabled( boolean enabled );
239
240 /**
241 * @return true if warning is enabled false otherwise.
242 */
243 boolean isWarningEnabled();
244
245 /**
246 * @param enabled enable warning or disable.
247 */
248 void setWarningEnabled( boolean enabled );
249
250 /**
251 * @return true if error is enabled false otherwise.
252 */
253 boolean isErrorEnabled();
254
255 /**
256 * @param enabled enable error or disable.
257 */
258 void setErrorEnabled( boolean enabled );
259
260 /**
261 * @return true if server is enabled false otherwise.
262 */
263 boolean isSevereEnabled();
264
265 /**
266 * @param enabled enable server or disable.
267 */
268 void setSevereEnabled( boolean enabled );
269
270 /**
271 * @return true if empty false otherwise.
272 */
273 boolean isEmpty();
274
275 /**
276 * @return rendered.
277 */
278 String render();
279
280 /**
281 * @param sink {@link MessageSink}
282 */
283 void render( MessageSink sink );
284
285 /**
286 * flush.
287 */
288 void flush();
289
290 }