001/*
002 * ============================================================================
003 * Copyright © 2002-2022 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 org.apiguardian.api.API.Status.STABLE;
021
022import java.io.Serial;
023
024import org.apiguardian.api.API;
025import org.tquadrat.foundation.annotation.ClassVersion;
026
027/**
028 *  This is a specialized implementation for the
029 *  {@link IllegalArgumentException}
030 *  that should be used instead of the latter in cases where a blank String is
031 *  provided as an illegal argument value.
032 *
033 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
034 *  @version $Id: BlankArgumentException.java 1025 2022-03-11 16:26:00Z tquadrat $
035 *  @since 0.1.0
036 *
037 *  @UMLGraph.link
038 */
039@ClassVersion( sourceVersion = "$Id: BlankArgumentException.java 1025 2022-03-11 16:26:00Z tquadrat $" )
040@API( status = STABLE, since = "0.1.0" )
041public final class BlankArgumentException extends NullArgumentException
042{
043        /*------------------------*\
044    ====** Static Initialisations **===========================================
045        \*------------------------*/
046    /**
047     *  The serial version UID for objects of this class: {@value}.
048     *
049     *  @hidden
050     */
051    @Serial
052    private static final long serialVersionUID = 1174360235354917591L;
053
054        /*--------------*\
055    ====** Constructors **=====================================================
056        \*--------------*/
057    /**
058     *  Creates a new instance of {@code BlankArgumentException}.
059     */
060    public BlankArgumentException() { this( null ); }
061
062    /**
063     *  Creates a new instance of {@code BlankArgumentException}.
064     *
065     *  @param  argName The name of the argument whose value was provided as
066     *      blank; if {@code null} or the empty String, a default message
067     *      is used that does not use the name of the argument.
068     */
069    public BlankArgumentException( final String argName )
070    {
071        super( argName, "Argument '%1$s' must not be blank", "Argument must not be blank" );
072    }   //  BlankArgumentException()
073}
074//  class BlankArgumentException
075
076/*
077 *  End of File
078 */