sviolet.slate.common.x.conversion.mapxbean.ConversionExceptionThrower Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015-2020 S.Violet
 *
 * Licensed 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.
 *
 * Project GitHub: https://github.com/shepherdviolet/slate
 * Email: [email protected]
 */

package sviolet.slate.common.x.conversion.mapxbean;

/**
 * Used to throw exceptions in a sub processor
 *
 * @author S.Violet
 * @see MapXBean
 */
public interface ConversionExceptionThrower {

    /**
     * Used to throw exceptions in a sub processor,
     * Notice that no exception is thrown when throwExceptionIfFails = false.
     *
     * @param message Error message
     * @param cause Error cause, Nullable
     * @param conversionPath It represents the conversion path when the exception is thrown, Nullable
     * @throws ConversionRuntimeException No exception is thrown when throwExceptionIfFails = false
     */
    void throwConversionException(String message, Throwable cause, ConversionPath conversionPath) throws ConversionRuntimeException;

}