/*
 * 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
 *
 *     https://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.commons.configuration2.ex;

/**
 * Thrown when a property is incompatible with the type requested.
 *
 * @since 1.0
 */
public class ConversionException extends ConfigurationRuntimeException {

    /**
     * The serial version UID.
     */
    private static final long serialVersionUID = -5167943099293540392L;

    /**
     * Constructs a new {@code ConversionException} without specified detail message.
     */
    public ConversionException() {
    }

    /**
     * Constructs a new {@code ConversionException} with specified detail message.
     *
     * @param message the error message
     */
    public ConversionException(final String message) {
        super(message);
    }

    /**
     * Constructs a new {@code ConversionException} with specified detail message.
     *
     * @param format the error message for for {@link String#format(String, Object...)}.
     * @param params the error parameters for for {@link String#format(String, Object...)}.
     * @since 2.14.0
     */
    public ConversionException(final String format, final Object... params) {
        super(String.format(format, params));
    }

    /**
     * Constructs a new {@code ConversionException} with specified detail message and nested {@code Throwable}.
     *
     * @param message the error message.
     * @param cause   the exception or error that caused this exception to be thrown.
     */
    public ConversionException(final String message, final Throwable cause) {
        super(message, cause);
    }

    /**
     * Constructs a new {@code ConversionException} with specified nested {@code Throwable}.
     *
     * @param cause the exception or error that caused this exception to be thrown.
     */
    public ConversionException(final Throwable cause) {
        super(cause);
    }

    /**
     * Constructs a new {@code ConversionException} with specified detail message.
     *
     * @param format the error message for for {@link String#format(String, Object...)}.
     * @param params the error parameters for for {@link String#format(String, Object...)}.
     * @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.)
     * @since 2.14.0
     */
    public ConversionException(final Throwable cause, final String format, final Object... params) {
        super(cause, format, params);
    }
}
