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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
/*******************************************************************************
* Copyright (c) 2011 Google, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Google, Inc. - initial API and implementation
*******************************************************************************/
package org.eclipse.wb.internal.core.utils.check;
import java.text.MessageFormat;
/**
* <code>Assert</code> is useful for for embedding runtime sanity checks in code. The predicate
* methods all test a condition and throw some type of unchecked exception if the condition does not
* hold.
* <p>
* Assertion failure exceptions, like most runtime exceptions, are thrown when something is
* misbehaving. Assertion failures are invariably unspecified behavior; consequently, clients should
* never rely on these being thrown (and certainly should not being catching them specifically).
*
* @author scheglov_ke
* @coverage core.util
*/
public final class Assert {
////////////////////////////////////////////////////////////////////////////
//
// Constructor
//
////////////////////////////////////////////////////////////////////////////
private Assert() {
}
////////////////////////////////////////////////////////////////////////////
//
// "legal"
//
////////////////////////////////////////////////////////////////////////////
/**
* Asserts that an argument is legal. If the given boolean is not <code>true</code>, an
* <code>IllegalArgumentException</code> is thrown.
*
* @param expression
* the boolean expression of the check
* @return <code>true</code> if the check passes (does not return if the check fails)
* @exception IllegalArgumentException
* if the legality test failed
*/
public static boolean isLegal(boolean expression) {
return isLegal(expression, ""); //$NON-NLS-1$
}
/**
* Asserts that an argument is legal. If the given boolean is not <code>true</code>, an
* <code>IllegalArgumentException</code> is thrown. The given message is included in that
* exception, to aid debugging.
*
* @param expression
* the boolean expression of the check
* @param message
* the message to include in the exception
* @return <code>true</code> if the check passes (does not return if the check fails)
* @exception IllegalArgumentException
* if the legality test failed
*/
public static boolean isLegal(boolean expression, String message) {
if (!expression) {
throw new IllegalArgumentException(message);
}
return expression;
}
////////////////////////////////////////////////////////////////////////////
//
// "null"
//
////////////////////////////////////////////////////////////////////////////
/**
* Asserts that the given object is <code>null</code>. If this is not the case, some kind of
* unchecked exception is thrown.
*
* @param object
* the value to test
*/
public static void isNull(Object object) {
isNull(object, ""); //$NON-NLS-1$
}
/**
* Asserts that the given object is <code>null</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param object
* the value to test
* @param message
* the message to include in the exception
*/
public static void isNull(Object object, String message) {
if (object != null) {
throw new AssertionFailedException("null argument expected: " + message); //$NON-NLS-1$
}
}
/**
* Asserts that the given object is not <code>null</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param object
* the value to test
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link String#format(String, Object...)}. For example
* <code>"Execution flow problem. %s expected, but %s found."</code>.
* @param args
* the arguments for {@code errorFormat}
*/
public static void isNull(Object object, String errorFormat, Object... args) {
if (object != null) {
fail("null argument expected: " + String.format(errorFormat, args)); //$NON-NLS-1$
}
}
/**
* @param errorFormat
* the format of error message suitable for {@link MessageFormat}.
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link MessageFormat}. For example
* <code>"Execution flow problem. {0} expected, but {1} found."</code>.
*/
public static void isNull2(Object object, String errorFormat, Object... args) {
if (object != null) {
String message = "null argument expected: " + MessageFormat.format(errorFormat, args); //$NON-NLS-1$
fail(message);
}
}
////////////////////////////////////////////////////////////////////////////
//
// not "null"
//
////////////////////////////////////////////////////////////////////////////
/**
* Asserts that the given object is not <code>null</code>. If this is not the case, some kind of
* unchecked exception is thrown.
*
* @param object
* the value to test
*/
public static void isNotNull(Object object) {
isNotNull(object, ""); //$NON-NLS-1$
}
/**
* Asserts that the given object is not <code>null</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param object
* the value to test
* @param message
* the message to include in the exception
*/
public static void isNotNull(Object object, String message) {
if (object == null) {
fail("null argument: " + message); //$NON-NLS-1$
}
}
/**
* Asserts that the given object is not <code>null</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param object
* the value to test
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link String#format(String, Object...)}. For example
* <code>"Execution flow problem. %s expected, but %s found."</code>.
* @param args
* the arguments for {@code errorFormat}
*/
public static void isNotNull(Object object, String errorFormat, Object... args) {
if (object == null) {
fail("null argument: " + String.format(errorFormat, args)); //$NON-NLS-1$
}
}
/**
* @param errorFormat
* the format of error message suitable for {@link MessageFormat}.
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link MessageFormat}. For example
* <code>"Execution flow problem. {0} expected, but {1} found."</code>.
*/
public static void isNotNull2(Object object, String errorFormat, Object... args) {
if (object == null) {
String message = "null argument: " + MessageFormat.format(errorFormat, args); //$NON-NLS-1$
fail(message);
}
}
////////////////////////////////////////////////////////////////////////////
//
// Fail
//
////////////////////////////////////////////////////////////////////////////
/**
* Fails with given message.
*
* @param message
* the message to include in the exception
*/
public static void fail(String message) {
throw new AssertionFailedException(message);
}
/**
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link MessageFormat}. For example <code>"{0} expected, but {1} found."</code>.
*/
public static void fail(String errorFormat, Object... args) {
String message = MessageFormat.format(errorFormat, args);
throw new AssertionFailedException(message);
}
////////////////////////////////////////////////////////////////////////////
//
// "true"
//
////////////////////////////////////////////////////////////////////////////
/**
* Asserts that the given boolean is <code>true</code>. If this is not the case, some kind of
* unchecked exception is thrown.
*
* @param expression
* the boolean expression of the check
* @return <code>true</code> if the check passes (does not return if the check fails)
*/
public static boolean isTrue(boolean expression) {
return isTrue(expression, ""); //$NON-NLS-1$
}
/**
* Asserts that the given boolean is <code>true</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param expression
* the boolean expression of the check
* @param message
* the message to include in the exception
* @return <code>true</code> if the check passes (does not return if the check fails)
*/
public static boolean isTrue(boolean expression, String message) {
if (!expression) {
fail("assertion failed: " + message); //$NON-NLS-1$
}
return expression;
}
/**
* Asserts that the given boolean is <code>true</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param expression
* the boolean expression of the check
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link String#format(String, Object...)}. For example
* <code>"Execution flow problem. %s expected, but %s found."</code>.
* @param args
* the arguments for {@code errorFormat}
* @return <code>true</code> if the check passes (does not return if the check fails)
*/
public static boolean isTrue(boolean expression, String errorFormat, Object... args) {
if (!expression) {
fail("assertion failed: " + String.format(errorFormat, args)); //$NON-NLS-1$
}
return expression;
}
/**
* Asserts that the given boolean is <code>true</code>. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param expression
* the boolean expression to check.
* @param errorFormat
* the format of error message to produce if the check fails, as expected by
* {@link MessageFormat}. For example <code>"{0} expected, but {1} found."</code>.
*/
public static boolean isTrue2(boolean expression, String errorFormat, Object... args) {
if (!expression) {
fail(errorFormat, args);
}
return expression;
}
////////////////////////////////////////////////////////////////////////////
//
// equals
//
////////////////////////////////////////////////////////////////////////////
/**
* Asserts that given actual value equals expected value. If this is not the case, some kind of
* unchecked exception is thrown.
*
* @param expected
* the expected value
* @param the
* actual value to check
*/
public static void equals(int expected, int actual) {
equals(expected, actual, expected + " expected, but " + actual + " found");
}
/**
* Asserts that given actual value equals expected value. If this is not the case, some kind of
* unchecked exception is thrown. The given message is included in that exception, to aid
* debugging.
*
* @param expected
* the expected value
* @param the
* actual value to check
* @param message
* the message to include in the exception
*/
public static void equals(int expected, int actual, String message) {
if (expected != actual) {
fail("assertation failed: " + message);
}
}
////////////////////////////////////////////////////////////////////////////
//
// instanceOf
//
////////////////////////////////////////////////////////////////////////////
/**
* Asserts that given object is not <code>null</code> and has class compatible with given.
*/
public static void instanceOf(Class<?> expectedClass, Object o) {
if (o == null) {
fail(expectedClass.getName() + " expected, but 'null' found.");
}
if (!expectedClass.isAssignableFrom(o.getClass())) {
fail(expectedClass.getName() + " expected, but " + o.getClass().getName() + " found.");
}
}
}
|
