StringSQLRenderer.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2015 ForgeRock AS. All rights reserved.
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * http://forgerock.org/license/CDDLv1.0.html
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at http://forgerock.org/license/CDDLv1.0.html
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 */
package org.forgerock.openidm.repo.util;

/**
 * An {@link SQLRenderer} implementation that renders SQL as a String
 */
public class StringSQLRenderer implements SQLRenderer<String> {
    private final StringBuilder sb = new StringBuilder();

    /**
     * Constructor.
     */
    public StringSQLRenderer() {
    }

    /**
     * Constructor.
     *
     * @param s the string to start
     */
    public StringSQLRenderer(String s) {
        sb.append(s);
    }

    /**
     * Append an additional SQL string.
     *
     * @param s the additional SQL string
     * @return the StringSQLRenderer object
     */
    public StringSQLRenderer append(String s) {
        sb.append(s);
        return this;
    }

    /**
     * Render the SQL as a String.
     *
     * @return the SQL String.
     */
    @Override
    public String toSQL() {
        return sb.toString();
    }

    /**
     * Provide a string representation of this object.
     *
     * @return the SQL string represented by this object.
     */
    @Override
    public String toString() {
        return toSQL();
    }
}