001/*
002 * ============================================================================
003 * Copyright © 2002-2020 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 an empty String,
031 *  array or
032 *  {@link java.util.Collection}
033 *  argument is provided as an illegal argument value.
034 *
035 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
036 *  @version $Id: EmptyArgumentException.java 820 2020-12-29 20:34:22Z tquadrat $
037 *  @since 0.0.5
038 *
039 *  @UMLGraph.link
040 */
041@ClassVersion( sourceVersion = "$Id: EmptyArgumentException.java 820 2020-12-29 20:34:22Z tquadrat $" )
042@API( status = STABLE, since = "0.0.5" )
043public final class EmptyArgumentException extends NullArgumentException
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 instance of {@code EmptyArgumentException}.
061     */
062    public EmptyArgumentException() { this( null ); }
063
064    /**
065     *  Creates a new instance of {@code EmptyArgumentException}.
066     *
067     *  @param  argName The name of the argument whose value was provided as
068     *      empty; if {@code null} or the empty String, a default message
069     *      is used that does not use the name of the argument.
070     */
071    public EmptyArgumentException( final String argName )
072    {
073        super( argName, "Argument '%1$s' must not be empty", "Argument must not be empty" );
074    }   //  EmptyArgumentException()
075}
076//  class EmptyArgumentException
077
078/*
079 *  End of File
080 */