DumpArchiveException.java

  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. package org.apache.commons.compress.archivers.dump;

  20. import org.apache.commons.compress.archivers.ArchiveException;

  21. /**
  22.  * Signals that an dump archive exception of some sort has occurred.
  23.  */
  24. public class DumpArchiveException extends ArchiveException {

  25.     private static final long serialVersionUID = 1L;

  26.     /**
  27.      * Constructs a {@code DumpArchiveException} with {@code null} as its error detail message.
  28.      */
  29.     public DumpArchiveException() {
  30.     }

  31.     /**
  32.      * Constructs a {@code DumpArchiveException} with the specified detail message.
  33.      *
  34.      * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
  35.      */
  36.     public DumpArchiveException(final String message) {
  37.         super(message);
  38.     }

  39.     /**
  40.      * Constructs a {@code DumpArchiveException} with the specified detail message and cause.
  41.      *
  42.      * <p>
  43.      * Note that the detail message associated with {@code cause} is <em>not</em> automatically incorporated into this exception's detail message.
  44.      * </p>
  45.      *
  46.      * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
  47.      *
  48.      * @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
  49.      *                is nonexistent or unknown.)
  50.      */
  51.     public DumpArchiveException(final String message, final Throwable cause) {
  52.         super(message, cause);
  53.     }

  54.     /**
  55.      * Constructs a {@code DumpArchiveException} with the specified cause and a detail message of {@code (cause==null ? null : cause.toString())} (which
  56.      * typically contains the class and detail message of {@code cause}). This constructor is useful for IO exceptions that are little more than wrappers for
  57.      * other throwables.
  58.      *
  59.      * @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
  60.      *              is nonexistent or unknown.)
  61.      */
  62.     public DumpArchiveException(final Throwable cause) {
  63.         super(cause);
  64.     }
  65. }