001/*
002 * ============================================================================
003 * Copyright © 2002-2022 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.sql.internal;
020
021import static org.apiguardian.api.API.Status.INTERNAL;
022
023import java.io.Serial;
024import java.io.Serializable;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028
029/**
030 *  A variable for an
031 *  {@link org.tquadrat.foundation.sql.EnhancedPreparedStatement EnhancedPreparedStatement}.
032 *
033 *  @param  name    The name of the variable.
034 *  @param  position    The position for this variable in the
035 *      {@link java.sql.PreparedStatement}.
036 *
037 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
038 *  @version $Id: StatementVariable.java 1020 2022-02-27 21:26:03Z tquadrat $
039 *  @since 0.0.1
040 *
041 *  @UMLGraph.link
042 */
043@ClassVersion( sourceVersion = "$Id: StatementVariable.java 1020 2022-02-27 21:26:03Z tquadrat $" )
044@API( status = INTERNAL, since = "0.0.1" )
045public record StatementVariable( String name, int position) implements Serializable
046{
047        /*------------------------*\
048    ====** Static Initialisations **===========================================
049        \*------------------------*/
050    /**
051     *  The serial version UID for objects of this class: {@value}.
052     *
053     *  @hidden
054     */
055    @Serial
056    private static final long serialVersionUID = 1L;
057
058        /*---------*\
059    ====** Methods **==========================================================
060        \*---------*/
061    /**
062     *  {@inheritDoc}
063     */
064    @Override
065    public final String toString()
066    {
067        final var retValue = getClass().getName() +
068            " [Name: " + name +
069            ", Position: " + position +
070            "]";
071
072        //---* Done *----------------------------------------------------------
073        return retValue;
074    }   //  toString()
075}
076//  record StatementVariable
077
078/*
079 *  End of File
080 */