org.jooq.util.db2.DB2FunctionDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jooq-meta Show documentation
There is a newer version: 3.19.16
/**
 * Copyright (c) 2009-2011, Lukas Eder, [email protected]
 * All rights reserved.
 *
 * This software is licensed to you under the Apache License, Version 2.0
 * (the "License"); You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * . Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * . Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * . Neither the name "jOOQ" nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package org.jooq.util.db2;

import java.sql.SQLException;

import org.jooq.util.AbstractFunctionDefinition;
import org.jooq.util.DataTypeDefinition;
import org.jooq.util.Database;
import org.jooq.util.DefaultDataTypeDefinition;
import org.jooq.util.DefaultParameterDefinition;
import org.jooq.util.PackageDefinition;
import org.jooq.util.ParameterDefinition;

/**
 * DB2 implementation of {@link AbstractFunctionDefinition}
 *
 * @author Espen Stromsnes
 */
public class DB2FunctionDefinition extends AbstractFunctionDefinition {

    public DB2FunctionDefinition(Database database, PackageDefinition pkg, String name, String comment) {
        super(database, pkg, name, comment, null);
    }

    /**
     * Sets the return value of the function
     *
     * @param dataType the return value data type
     */
    public void setReturnValue(String dataType) {
        DataTypeDefinition type = new DefaultDataTypeDefinition(getDatabase(), dataType);
        this.returnValue = new DefaultParameterDefinition(this, "RETURN_VALUE", -1, type);
    }

    /**
     * Adds parameter to function
     *
     * @param paramName parameter name
     * @param position parameter ordinal position
     * @param paramType parameter data type
     */
    public void addParameter(String paramName, int position, String paramType) {
        DataTypeDefinition type = new DefaultDataTypeDefinition(getDatabase(), paramType);
        ParameterDefinition column = new DefaultParameterDefinition(this, paramName, position, type);

        getInParameters().add(column);
    }

    @Override
    protected void init0() throws SQLException {}
}