001/*
002 * ============================================================================
003 * Copyright © 2002-2021 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.config;
020
021import static org.apiguardian.api.API.Status.STABLE;
022import static org.tquadrat.foundation.lang.Objects.requireNotEmptyArgument;
023
024import java.io.Serial;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028import org.tquadrat.foundation.exception.ValidationException;
029
030/**
031 *  This exception type is used to signal a problem with the initialisation of
032 *  a configuration bean.
033 *
034 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
035 *  @version $Id: ConfigInitException.java 884 2021-03-22 18:02:51Z tquadrat $
036 *  @since 0.0.1
037 *
038 *  @UMLGraph.link
039 */
040@ClassVersion( sourceVersion = "$Id: ConfigInitException.java 884 2021-03-22 18:02:51Z tquadrat $" )
041@API( status = STABLE, since = "0.0.1" )
042public class ConfigInitException extends ValidationException
043{
044        /*------------------------*\
045    ====** Static Initialisations **===========================================
046        \*------------------------*/
047    /**
048     *  The serial version UID for objects of this class: {@value}.
049     *
050     *  @hidden
051     */
052    @Serial
053    private static final long serialVersionUID = 1L;
054
055        /*--------------*\
056    ====** Constructors **=====================================================
057        \*--------------*/
058    /**
059     *  Creates a new {@code ConfigInitException} instance.
060     *
061     *  @param  message The message that provides details on the failed
062     *      validation.
063     */
064    public ConfigInitException( final String message )
065    {
066        super( requireNotEmptyArgument( message, "message" ) );
067    }   //  ConfigInitException()
068
069    /**
070     *  Creates a new {@code ConfigInitException} instance.
071     *
072     *  @param  message The message that provides details on the failed
073     *      validation.
074     *  @param  cause   The exception that is related to the initialisation
075     *      error.
076     */
077    public ConfigInitException( final String message, final Throwable cause )
078    {
079        super( requireNotEmptyArgument( message, "message" ), cause );
080    }   //  ConfigInitException()
081}
082//  class ConfigInitException
083
084/*
085 *  End of File
086 */