org.apache.sling.distribution.ImportPreProcessException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.sling.distribution;

/**
 * Exception thrown to indicate an issue that prevents the content from being
 * imported successfully during the pre-import processing phase. This exception
 * is used within the {@link ImportPreProcessor} to signal failures in pre-import
 * checks, validations, or any other preparatory operations required before the
 * content import begins.
 */
public class ImportPreProcessException extends Exception {

    /**
     * Constructs a new ImportPreProcessException with the specified detail
     * message. The cause is not initialized, and may subsequently be
     * initialized by a call to {@link #initCause}.
     *
     * @param message the detail message. The detail message is saved for
     *                later retrieval by the {@link #getMessage()} method.
     */
    public ImportPreProcessException(String message) {
        super(message);
    }

    /**
     * Constructs a new ImportPreProcessException with the specified detail
     * message and cause.
     * Note that the detail message associated with {@code cause} is
     * not automatically incorporated in this exception's detail message.
     *
     * @param message the detail message (which is saved for later retrieval
     *                by the {@link #getMessage()} method).
     * @param cause the cause (which is saved for later retrieval by the
     *              {@link #getCause()} method). (A {@code null} value is
     *              permitted, and indicates that the cause is nonexistent
     *              or unknown.)
     */
    public ImportPreProcessException(String message, Throwable cause) {
        super(message, cause);
    }

    /**
     * Constructs a new ImportPreProcessException with the specified cause and a
     * detail message of {@code (cause==null ? null : cause.toString())} (which
     * typically contains the class and detail message of {@code cause}).
     * This constructor is useful for exceptions that are little more than
     * wrappers for other throwables (for example, {@link java.security.PrivilegedActionException}).
     *
     * @param cause the cause (which is saved for later retrieval by the
     *              {@link #getCause()} method). (A {@code null} value is
     *              permitted, and indicates that the cause is nonexistent
     *              or unknown.)
     */
    public ImportPreProcessException(Throwable cause) {
        super(cause);
    }
}