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.util.Arrays;
031import java.util.List;
032
033import com.google.common.collect.Lists;
034
035/**
036 * A helper class used to accumulate SQL fragments together with the corresponding query parameters.<p>
037 *
038 * @since 8.0.0
039 */
040public class CmsStatementBuilder {
041
042    /** The buffer containing the SQL. */
043    private StringBuffer m_buffer = new StringBuffer();
044
045    /** The list containing the query parameters. */
046    private List<Object> m_params = Lists.newArrayList();
047
048    /**
049     * Adds an SQL fragment and zero or more query parameters.<p>
050     *
051     * @param fragment the SQL fragment
052     * @param params the query parameters
053     */
054    public void add(String fragment, List<Object> params) {
055
056        m_buffer.append(fragment);
057        m_params.addAll(params);
058    }
059
060    /**
061     * Adds an SQL fragment and zero or more query parameters.<p>
062     *
063     * @param fragment the SQL fragment
064     * @param params the query parameters
065     */
066    public void add(String fragment, Object... params) {
067
068        m_buffer.append(fragment);
069        m_params.addAll(Arrays.asList(params));
070    }
071
072    /**
073     * Returns the list of accumulated query parameters.<p>
074     *
075     * @return the list of accumulated query parameters
076     */
077    public List<Object> getParameters() {
078
079        return m_params;
080    }
081
082    /**
083     * Returns the accumulated query string.<p>
084     *
085     * @return the accumulated query string
086     */
087    public String getQuery() {
088
089        return m_buffer.toString();
090    }
091}