forked from assertj/assertj
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFail.java
More file actions
87 lines (77 loc) · 3.41 KB
/
Fail.java
File metadata and controls
87 lines (77 loc) · 3.41 KB
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
/**
* Licensed 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.
*
* Copyright 2012-2014 the original author or authors.
*/
package org.assertj.core.api;
import org.assertj.core.internal.Failures;
import static java.lang.String.format;
/**
* Common failures.
*
* @author Alex Ruiz
* @author Yvonne Wang
* @author Joel Costigliola
*/
public final class Fail {
/**
* Sets whether we remove elements related to AssertJ from assertion error stack trace.
* @param removeAssertJRelatedElementsFromStackTrace flag.
*/
public static void setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace) {
Failures.instance().setRemoveAssertJRelatedElementsFromStackTrace(removeAssertJRelatedElementsFromStackTrace);
}
/**
* Fails with the given message.
* @param failureMessage error message.
* @throws AssertionError with the given message.
*/
public static void fail(String failureMessage) {
throw Failures.instance().failure(failureMessage);
}
/**
* Throws an {@link AssertionError} with the given message and with the {@link Throwable} that caused the failure.
* @param failureMessage the description of the failed assertion. It can be {@code null}.
* @param realCause cause of the error.
* @throws AssertionError with the given message and with the {@link Throwable} that caused the failure.
*/
public static void fail(String failureMessage, Throwable realCause) {
AssertionError error = Failures.instance().failure(failureMessage);
error.initCause(realCause);
throw error;
}
/**
* Throws an {@link AssertionError} with a message explaining that a {@link Throwable} of given class was expected to be thrown
* but had not been.
* @param throwableClass the Throwable class that was expected to be thrown.
* @throws AssertionError with a message explaining that a {@link Throwable} of given class was expected to be thrown but had
* not been.
*
* {@link Fail#shouldHaveThrown(Class)} can be used as a replacement.
*/
public static void failBecauseExceptionWasNotThrown(Class<? extends Throwable> throwableClass) {
shouldHaveThrown(throwableClass);
}
/**
* Throws an {@link AssertionError} with a message explaining that a {@link Throwable} of given class was expected to be thrown
* but had not been.
* @param throwableClass the Throwable class that was expected to be thrown.
* @throws AssertionError with a message explaining that a {@link Throwable} of given class was expected to be thrown but had
* not been.
*/
public static void shouldHaveThrown(Class<? extends Throwable> throwableClass) {
throw Failures.instance().failure(format("Expected %s to be thrown", throwableClass.getSimpleName()));
}
/**
* This constructor is protected to make it possible to subclass this class. Since all its methods are static, there is no point
* on creating a new instance of it.
*/
protected Fail() {}
}