org.firebirdsql.jdbc.escape.PatternSQLFunction 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.escape;

import java.text.MessageFormat;

/**
 * Implementation of {@link SQLFunction} with a function pattern.
 * 
 * The pattern is a {@link java.text.MessageFormat} pattern string.
 * 
 *
 * @author Mark Rotteveel
 * @since 4.0
 */
final class PatternSQLFunction implements SQLFunction {

    private final String functionPattern;

    /**
     * Creates the pattern-based SQL function.
     *
     * @param functionPattern
     *         {@link MessageFormat} pattern for the function
     */
    PatternSQLFunction(String functionPattern) {
        this.functionPattern = functionPattern;
    }

    /**
     * {@inheritDoc}
     * 
     * This implementation will not throw a {@code FBSQLParseException} if the wrong number of parameters are passed.
     * 
     */
    @Override
    public String apply(String... parameters) {
        return MessageFormat.format(functionPattern, (Object[]) parameters);
    }
}