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 * https://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
20 package org.apache.commons.compress.archivers.dump;
21
22 import org.apache.commons.compress.archivers.ArchiveException;
23
24 /**
25 * Signals that an dump archive exception of some sort has occurred.
26 */
27 public class DumpArchiveException extends ArchiveException {
28
29 private static final long serialVersionUID = 1L;
30
31 /**
32 * Constructs a {@code DumpArchiveException} with {@code null} as its error detail message.
33 */
34 public DumpArchiveException() {
35 }
36
37 /**
38 * Constructs a {@code DumpArchiveException} with the specified detail message.
39 *
40 * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
41 */
42 public DumpArchiveException(final String message) {
43 super(message);
44 }
45
46 /**
47 * Constructs a {@code DumpArchiveException} with the specified detail message and cause.
48 *
49 * <p>
50 * Note that the detail message associated with {@code cause} is <em>not</em> automatically incorporated into this exception's detail message.
51 * </p>
52 *
53 * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
54 *
55 * @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method). (A null value is permitted, and indicates that the cause
56 * is nonexistent or unknown.)
57 */
58 public DumpArchiveException(final String message, final Throwable cause) {
59 super(message, cause);
60 }
61
62 /**
63 * Constructs a {@code DumpArchiveException} with the specified cause and a detail message of {@code (cause==null ? null : cause.toString())} (which
64 * typically contains the class and detail message of {@code cause}). This constructor is useful for IO exceptions that are little more than wrappers for
65 * other throwables.
66 *
67 * @param cause The cause (which is saved for later retrieval by the {@link #getCause()} method). (A null value is permitted, and indicates that the cause
68 * is nonexistent or unknown.)
69 */
70 public DumpArchiveException(final Throwable cause) {
71 super(cause);
72 }
73 }