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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.tuscany.sca.monitor;
import java.util.List;
import org.apache.tuscany.sca.monitor.Problem.Severity;
/**
* A monitor for the watching for validation problems
*
* @version $Rev$ $Date$
*/
public abstract class Monitor {
/**
* Reports a build problem.
*
* @param problem
*/
public abstract void problem(Problem problem);
/**
* Returns a list of reported problems.
*
* @return the list of problems. The list may be empty
*/
public abstract List<Problem> getProblems();
/**
* Create a new problem.
*
* @param sourceClassName the class name reporting the problem
* @param bundleName the name of the message bundle to use
* @param severity the severity of the problem
* @param problemObject the model object for which the problem is being reported
* @param messageId the id of the problem message
* @param cause the exception which caused the problem
* @return
*/
public abstract Problem createProblem(String sourceClassName,
String bundleName,
Severity severity,
Object problemObject,
String messageId,
Exception cause);
/**
* Create a new problem.
*
* @param sourceClassName the class name reporting the problem
* @param bundleName the name of the message bundle to use
* @param severity the severity of the problem
* @param problemObject the model object for which the problem is being reported
* @param messageId the id of the problem message
* @param messageParams the parameters of the problem message
* @return
*/
public abstract Problem createProblem(String sourceClassName,
String bundleName,
Severity severity,
Object problemObject,
String messageId,
Object... messageParams);
/**
* A utility function for raising a warning. It creates the problem and
* adds it to the monitor
*
* @param monitor
* @param reportingObject
* @param messageBundle
* @param messageId
* @param messageParameters
*/
public static void warning (Monitor monitor,
Object reportingObject,
String messageBundle,
String messageId,
String... messageParameters){
if (monitor != null) {
Problem problem =
monitor.createProblem(reportingObject.getClass().getName(),
messageBundle,
Severity.WARNING,
null,
messageId,
(Object[])messageParameters);
monitor.problem(problem);
}
}
/**
* A utility function for raising an error. It creates the problem and
* adds it to the monitor
*
* @param monitor
* @param reportingObject
* @param messageBundle
* @param messageId
* @param messageParameters
*/
public static void error (Monitor monitor,
Object reportingObject,
String messageBundle,
String messageId,
String... messageParameters){
if (monitor != null) {
Problem problem =
monitor.createProblem(reportingObject.getClass().getName(),
messageBundle,
Severity.ERROR,
null,
messageId,
(Object[])messageParameters);
monitor.problem(problem);
}
}
/**
* A utility function for raising an error. It creates the problem and
* adds it to the monitor
*
* @param monitor
* @param reportingObject
* @param messageBundle
* @param messageId
* @param exception
*/
public static void error (Monitor monitor,
Object reportingObject,
String messageBundle,
String messageId,
Exception cause){
if (monitor != null) {
Problem problem =
monitor.createProblem(reportingObject.getClass().getName(),
messageBundle,
Severity.ERROR,
null,
messageId,
cause);
monitor.problem(problem);
}
}
}
|
