001/*
002 * ============================================================================
003 * Copyright © 2002-2023 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.exception;
019
020import static java.lang.String.format;
021import static org.apiguardian.api.API.Status.STABLE;
022import static org.tquadrat.foundation.lang.Objects.requireNonNullArgument;
023import static org.tquadrat.foundation.lang.Objects.requireNotEmptyArgument;
024
025import java.io.Serial;
026
027import org.apiguardian.api.API;
028import org.tquadrat.foundation.annotation.ClassVersion;
029
030/**
031 *  This is a specialized implementation for
032 *  {@link Error}
033 *  that is to be thrown especially from the {@code default} branch of a
034 *  {@code switch} statement that uses an {@code enum} type as selector.
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: UnsupportedEnumError.java 1060 2023-09-24 19:21:40Z tquadrat $
038 *  @since 0.0.5
039 *
040 *  @UMLGraph.link
041 */
042@ClassVersion( sourceVersion = "$Id: UnsupportedEnumError.java 1060 2023-09-24 19:21:40Z tquadrat $" )
043@API( status = STABLE, since = "0.0.5" )
044public final class UnsupportedEnumError extends Error
045{
046        /*-----------*\
047    ====** Constants **========================================================
048        \*-----------*/
049    /**
050     *  The message text.
051     */
052    private static final String MSG_UnsupportedEnum = "The value '%2$s' of enum class '%1$s' is not supported";
053
054        /*------------------------*\
055    ====** Static Initialisations **===========================================
056        \*------------------------*/
057    /**
058     *  The serial version UID for objects of this class: {@value}.
059     *
060     *  @hidden
061     */
062    @Serial
063    private static final long serialVersionUID = 1174360235354917591L;
064
065        /*--------------*\
066    ====** Constructors **=====================================================
067        \*--------------*/
068    /**
069     *  Creates a new instance of this class.
070     *
071     *  @param <T>  The type of the enum.
072     *  @param  value   The unsupported value.
073     */
074    public <T extends Enum<T>> UnsupportedEnumError( final T value )
075    {
076        super( format( MSG_UnsupportedEnum, requireNonNullArgument( value, "value" ).getClass().getName(), value.name() ) );
077    }   //  UnsupportedEnumError()
078
079    /**
080     *  Creates a new instance of this class.
081     *
082     *  @param  type    The class of the enum.
083     *  @param  value   The unsupported value.
084     */
085    public UnsupportedEnumError( final Class<? extends Enum<?>> type, final String value )
086    {
087        super( format( MSG_UnsupportedEnum, requireNonNullArgument( type, "type" ).getName(), requireNotEmptyArgument( value, "value" ) ) );
088    }   //  UnsupportedEnumError()
089}
090//  class UnsupportedEnumError
091
092/*
093 *  End of File
094 */