001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db;
029
030import java.sql.PreparedStatement;
031import java.sql.SQLException;
032
033/**
034 * A prepared statement parameter of type 'string'.<p>
035 *
036 * @since 8.0.0
037 */
038public class CmsPreparedStatementStringParameter implements I_CmsPreparedStatementParameter {
039
040    /** The actual value of the prepared statement parameter. */
041    String m_param;
042
043    /**
044     * Constructs a new prepared statement parameter with a value of type 'string'.<p>
045     *
046     * @param param the string value
047     */
048    public CmsPreparedStatementStringParameter(String param) {
049
050        m_param = param;
051    }
052
053    /**
054     * @see org.opencms.db.I_CmsPreparedStatementParameter#insertIntoStatement(java.sql.PreparedStatement, int)
055     */
056    public void insertIntoStatement(PreparedStatement stmt, int index) throws SQLException {
057
058        stmt.setString(index, m_param);
059    }
060
061}