1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.api;
20
21 import java.io.Serial;
22
23 /**
24 * This exception is used to indicate error conditions during RAT runs.
25 */
26 public class RatException extends Exception {
27 /**
28 * Creates a {@code RatException} out of any other type of exception.
29 * If the exception is already a {@code RatException}, just return it.
30 * @param exception the exception to convert.
31 * @return a {@code RatException}.
32 */
33 public static RatException makeRatException(final Exception exception) {
34 return exception instanceof RatException ? (RatException) exception : new RatException(exception);
35 }
36
37 @Serial
38 private static final long serialVersionUID = 4940711222435919034L;
39
40 /**
41 * Constructor.
42 */
43 public RatException() {
44 super();
45 }
46
47 /**
48 * Constructor with message and cause.
49 * @param message an error message to give more context.
50 * @param cause a cause.
51 */
52 public RatException(final String message, final Throwable cause) {
53 super(message, cause);
54 }
55
56 /**
57 * Constructor with message only.
58 * @param message an error message to give more context.
59 */
60 public RatException(final String message) {
61 super(message);
62 }
63
64 /**
65 * Constructor with cause only.
66 * @param cause a cause.
67 */
68 public RatException(final Throwable cause) {
69 super(cause);
70 }
71 }