001/*
002 * ============================================================================
003 *  Copyright © 2002-2021 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.javacomposer;
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 implementation of
029 *  {@link RuntimeException}
030 *  will be thrown by methods of JavaComposer in case an error condition
031 *  is encountered.
032 *
033 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
034 *  @version $Id: JavaComposerException.java 831 2021-01-05 17:25:46Z tquadrat $
035 *
036 *  @UMLGraph.link
037 *  @since 0.1.0
038 */
039@ClassVersion( sourceVersion = "$Id: JavaComposerException.java 831 2021-01-05 17:25:46Z tquadrat $" )
040@API( status = STABLE, since = "0.1.0" )
041public final class JavaComposerException extends RuntimeException
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 = 1L;
053
054        /*--------------*\
055    ====** Constructors **=====================================================
056        \*--------------*/
057    /**
058     *  Constructs a new instance of {@code JavaComposerException} with the
059     *  specified detail message. The cause is not initialized, and may
060     *  subsequently be initialized by a call to
061     *  {@link #initCause(Throwable)}.
062     *
063     *  @param  message The detail message. The detail message is saved for
064     *      later retrieval by the
065     *      {@link #getMessage()}
066     *      method.
067     */
068    public JavaComposerException( final String message ) { super( message ); }
069
070    /**
071     *  Constructs a new instance of {@code JavaComposerException} with the
072     *  specified detail message and a cause.
073     *
074     *  @note   The detail message associated with cause is not automatically
075     *      incorporated in this error's detail message.
076     *
077     *  @param  message The detail message. The detail message is saved for
078     *      later retrieval by the
079     *      {@link #getMessage()}
080     *      method.
081     *  @param  cause   The cause which is saved for later retrieval by the
082     *      {@link #getCause()} method. A {@code null} value is permitted, and
083     *      indicates that the cause is nonexistent or unknown.
084     */
085    public JavaComposerException( final String message, final Throwable cause ) { super( message, cause ); }
086}
087//  class JavaComposerException
088
089/*
090 *  End of File
091 */