Open Source Repository

Home /spring/spring-jdbc-3.0.5 | Repository Home



org/springframework/jdbc/core/SqlInOutParameter.java
/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.jdbc.core;

/**
 * Subclass of {@link SqlOutParameter} to represent an INOUT parameter.
 * Will return <code>true</code> for SqlParameter's {@link #isInputValueProvided}
 * test, in contrast to a standard SqlOutParameter.
 *
 <p>Output parameters - like all stored procedure parameters -
 * must have names.
 *
 @author Thomas Risberg
 @author Juergen Hoeller
 @since 2.0
 */
public class SqlInOutParameter extends SqlOutParameter {

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   */
  public SqlInOutParameter(String name, int sqlType) {
    super(name, sqlType);
  }

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   @param scale the number of digits after the decimal point
   * (for DECIMAL and NUMERIC types)
   */
  public SqlInOutParameter(String name, int sqlType, int scale) {
    super(name, sqlType, scale);
  }

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   @param typeName the type name of the parameter (optional)
   */
  public SqlInOutParameter(String name, int sqlType, String typeName) {
    super(name, sqlType, typeName);
  }

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   @param typeName the type name of the parameter (optional)
   @param sqlReturnType custom value handler for complex type (optional)
   */
  public SqlInOutParameter(String name, int sqlType, String typeName, SqlReturnType sqlReturnType) {
    super(name, sqlType, typeName, sqlReturnType);
  }

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   @param rse ResultSetExtractor to use for parsing the ResultSet
   */
  public SqlInOutParameter(String name, int sqlType, ResultSetExtractor rse) {
    super(name, sqlType, rse);
  }

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   @param rch RowCallbackHandler to use for parsing the ResultSet
   */
  public SqlInOutParameter(String name, int sqlType, RowCallbackHandler rch) {
    super(name, sqlType, rch);
  }

  /**
   * Create a new SqlInOutParameter.
   @param name name of the parameter, as used in input and output maps
   @param sqlType SQL type of the parameter according to java.sql.Types
   @param rm RowMapper to use for parsing the ResultSet
   */
  public SqlInOutParameter(String name, int sqlType, RowMapper rm) {
    super(name, sqlType, rm);
  }


  /**
   * This implementation always returns <code>true</code>.
   */
  @Override
  public boolean isInputValueProvided() {
    return true;
  }

}