org.firebirdsql.jdbc.metadata.NameHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc.metadata;

import org.firebirdsql.jdbc.QuoteStrategy;

/**
 * Helper methods for generating object names.
 *
 * @author Mark Rotteveel
 * @since 6
 */
final class NameHelper {

    private NameHelper() {
        // no instances
    }

    /**
     * Generates a name for the {@code SPECIFIC_NAME} column of {@code getFunctions}, {@code getFunctionColumns},
     * {@code getProcedures} and {@code getProcedureColumns}.
     *
     * @param catalog
     *         generally {@code null}, or — when {@code useCatalogAsPackage = true} — an empty string (no
     *         package) or a package name
     * @param routineName
     *         name of the routine (procedure or function)
     * @return specific name: for non-packaged routines the {@code routineName}, of packaged routines, both
     * {@code catalog} (package name) and {@code routineName} are transformed to quoted identifiers and separated by
     * {@code .} (period)
     */
    static String toSpecificName(String catalog, String routineName) {
        if (catalog == null || catalog.isEmpty()) {
            return routineName;
        }
        var quoteStrategy = QuoteStrategy.DIALECT_3;
        // 5: 4 quotes + 1 separator
        var sb = new StringBuilder(catalog.length() + routineName.length() + 5);
        quoteStrategy.appendQuoted(catalog, sb).append('.');
        quoteStrategy.appendQuoted(routineName, sb);
        return sb.toString();
    }

}