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
|
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2009 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.netbeans.validation.api;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
/**
* A collection of problems, to which a Validator can add additional problems.
*
* @author Tim Boudreau
*/
public final class Problems {
private final List<Problem> problems = new ArrayList<Problem>();
private boolean hasFatal;
/**
* Convenience method to add a problem with the specified message and
* Severity.FATAL
* @param problem
*/
public final void add (String problem) {
add (problem, Severity.FATAL);
}
/**
* Add a problem with the specified severity
* @param problem the message
* @param severity the severity
*/
public final void add (String problem, Severity severity) {
problems.add (new Problem (problem, severity));
hasFatal |= severity == Severity.FATAL;
}
/**
* Add a problem
* @param problem The problem (may be null)
*/
public final void add (Problem problem) {
if( problem == null ) { return; }
problems.add (problem);
hasFatal |= (problem.severity() == Severity.FATAL);
}
/**
* Dump all problems in another instance of Problems into this one.
* @param problems The other problems.
*/
public final void putAll (Problems problems) {
if (problems == this) throw new IllegalArgumentException (
"putAll to self"); //NOI18N
this.problems.addAll (problems.problems);
hasFatal |= (problems.hasFatal());
}
/**
* Determine if this set of problems includes any that are fatal.
* @return true if a fatal problem has been encountered
*/
public final boolean hasFatal() {
return hasFatal;
}
/**
* Create a new Problems with the initial (fatal) problem.
* @param message A localized message
* @return A Problems
*/
public static Problems create (String message) {
Problems result = new Problems();
result.add(message);
return result;
}
/**
* Get the {@code Problem} with the highest severity.
*
* If there is more than one problem with equal severity, <i>the
* one first added</i> will be considered more severe.
*
* @return The most severe {@code Problem} in this set
* @return null if there was no {@code Problem}
*/
public final Problem getLeadProblem() {
// Note that Collections.sort() is *stable*, a fact we use to guarantee
// this: of problems with equal severity, the problems added first will
// remain before the later ones, and will thusly be considered "more leading".
// (This may be helpful if the problems added first
// have *occured* more *recently* and thusly can be regarded as leading
// -- more natural to indicate to a user).
Collections.sort (problems);
return problems.isEmpty() ? null : problems.get(0);
}
/**
* Get the entire set of problems, sorted by severity first, order of
* addition second.
* @return A list of Problems
*/
public final List<? extends Problem> allProblems() {
List<Problem> result = new ArrayList<Problem>(problems.size());
result.addAll(problems);
Collections.sort(result);
return result;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
for (Iterator<Problem> it = problems.iterator(); it.hasNext();) {
Problem p = it.next();
sb.append (p);
if (it.hasNext()) {
sb.append (", ");
}
}
return sb.toString();
}
}
|
