001/*
002 * ============================================================================
003 *  Copyright © 2002-2024 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.sql;
019
020import static org.apiguardian.api.API.Status.STABLE;
021import static org.tquadrat.foundation.lang.Objects.isNull;
022
023import java.io.Serial;
024
025import org.apiguardian.api.API;
026import org.tquadrat.foundation.annotation.ClassVersion;
027
028/**
029 *  This exception will be thrown in cases where it is expected that a
030 *  {@code SELECT} statement should return not more than one single record, but
031 *  the
032 *  {@link java.sql.ResultSet ResultSet}
033 *  holds two or more records.
034 *
035 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
036 *  @version $Id: UniquenessViolationException.java 1093 2024-02-05 23:04:20Z tquadrat $
037 *  @since 0.4.1
038 *
039 *  @UMLGraph.link
040 */
041@ClassVersion( sourceVersion = "$Id: UniquenessViolationException.java 1093 2024-02-05 23:04:20Z tquadrat $" )
042@API( status = STABLE, since = "0.4.1" )
043public class UniquenessViolationException extends RuntimeException
044{
045        /*------------------------*\
046    ====** Static Initialisations **===========================================
047        \*------------------------*/
048    /**
049     *  The serial version UID for objects of this class: {@value}.
050     *
051     * @hidden
052     */
053    @Serial
054    private static final long serialVersionUID = 1174360235354917591L;
055
056        /*--------------*\
057    ====** Constructors **=====================================================
058        \*--------------*/
059    /**
060     *  Creates a new {@code UniquenessViolationException} instance.
061     *
062     *  @param  key The key that was used to access the table.
063     */
064    public UniquenessViolationException( final String key )
065    {
066        super( STR."Key '\{isNull( key ) ? "<?>" : key}' is not unqiue!"  );
067    }   //  UniquenessViolationException()
068}
069//  class UniquenessViolationException
070
071/*
072 *  End of File
073 */