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;
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 implementation of
030 *  {@link Error}
031 *  should be called from {@code private} constructors of static classes
032 *  (classes that does not allow any instances because they have only static
033 *  methods or constants). The message that is stored with the error is the
034 *  name of the respective class.
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: PrivateConstructorForStaticClassCalledError.java 820 2020-12-29 20:34:22Z tquadrat $
038 *  @since 0.0.5
039 *
040 *  @UMLGraph.link
041 *
042 *  @see AssertionError
043 */
044@ClassVersion( sourceVersion = "$Id: PrivateConstructorForStaticClassCalledError.java 820 2020-12-29 20:34:22Z tquadrat $" )
045@API( status = STABLE, since = "0.0.5" )
046public class PrivateConstructorForStaticClassCalledError extends AssertionError
047{
048        /*------------------------*\
049    ====** Static Initialisations **===========================================
050        \*------------------------*/
051    /**
052     *  The serial version UID for objects of this class: {@value}.
053     *
054     *  @hidden
055     */
056    @Serial
057    private static final long serialVersionUID = 1L;
058
059        /*--------------*\
060    ====** Constructors **=====================================================
061        \*--------------*/
062    /**
063     *  Creates a new {@code ErrorPrivateConstructorForStaticClassCalled} instance.
064     *
065     *  @param  message Should be the name of the respective static class.
066     */
067    public PrivateConstructorForStaticClassCalledError( final String message ) { super( requireNonNullArgument( message, "message" ) ); }
068
069    /**
070     *  Creates a new {@code ErrorPrivateConstructorForStaticClassCalled} instance.
071     *
072     *  @param  theClass    The respective static class.
073     */
074    public PrivateConstructorForStaticClassCalledError( final Class<?> theClass ) { this( requireNonNullArgument( theClass, "theClass" ).getName() ); }
075}
076//  class PrivateConstructorForStaticClassCalledError
077
078/*
079 *  End of File
080 */