1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016 ForgeRock AS.
15 */
16
17 package org.forgerock.api.markup;
18
19 /**
20 * Signals that an error occurred while generating API documentation.
21 */
22 public class ApiDocGeneratorException extends IllegalStateException {
23
24 /**
25 * Creates a {@link ApiDocGeneratorException} with a detailed error message.
26 *
27 * @param message Error message
28 */
29 public ApiDocGeneratorException(String message) {
30 super(message);
31 }
32
33 /**
34 * Creates a {@link ApiDocGeneratorException} with a detailed error message and cause.
35 *
36 * @param message Error message
37 * @param cause Cause
38 */
39 public ApiDocGeneratorException(String message, Throwable cause) {
40 super(message, cause);
41 }
42 }