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.xml.builder.spi;
019
020import static org.apiguardian.api.API.Status.MAINTAINED;
021import static org.tquadrat.foundation.lang.Objects.requireNonNullArgument;
022
023import java.io.Serial;
024
025import org.apiguardian.api.API;
026import org.tquadrat.foundation.annotation.ClassVersion;
027
028/**
029 *  This
030 *  {@link java.lang.RuntimeException Exception}
031 *  will be thrown when an invalid XML name is used for the creation of an XML
032 *  element, attribute, or namespace.
033 *
034 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
035 *  @version $Id: InvalidXMLNameException.java 980 2022-01-06 15:29:19Z tquadrat $
036 *  @since 0.0.5
037 *
038 *  @UMLGraph.link
039 */
040@ClassVersion( sourceVersion = "$Id: InvalidXMLNameException.java 980 2022-01-06 15:29:19Z tquadrat $" )
041@API( status = MAINTAINED, since = "0.0.5" )
042public class InvalidXMLNameException extends IllegalArgumentException
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 InvalidXMLNameException} instance.
060     *
061     *  @param  name    The invalid name.
062     */
063    public InvalidXMLNameException( final String name ) { super( requireNonNullArgument( name, "name" ) ); }
064}
065//  class InvalidXMLNameException
066
067/*
068 *  End of File
069 */