パッケージ org.springframework.jdbc.core.namedparam

インターフェース SqlParameterSource

すべての既知の実装クラス:
AbstractSqlParameterSource、BeanPropertySqlParameterSource、EmptySqlParameterSource、MapSqlParameterSource、SimplePropertySqlParameterSource
public interface SqlParameterSource
名前付き SQL パラメーターのパラメーター値を提供できるオブジェクトの共通機能を定義するインターフェース。NamedParameterJdbcTemplate 操作の引数として機能します。

このインターフェースでは、パラメーター値に加えて SQL 型を指定できます。すべてのパラメーター値と型は、パラメーターの名前を指定することによって識別されます。

Map や JavaBean などのさまざまな実装を一貫したインターフェースでラップすることを目的としています。

導入:
2.0
作成者:
Thomas Risberg, Juergen Hoeller
関連事項:

  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final int
    TYPE_UNKNOWN
    不明な（または未指定の）SQL 型を示す定数。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default StringSE[]
    getParameterNames()
    可能な場合は、使用可能なすべてのパラメーター名を列挙します。
    default int
    getSqlType(StringSE paramName)
    指定された名前付きパラメーターの SQL 型を判別します。
    default StringSE
    getTypeName(StringSE paramName)
    指定された名前付きパラメーターの型名を決定します。
    ObjectSE
    getValue(StringSE paramName)
    リクエストされた名前付きパラメーターのパラメーター値を返します。
    boolean
    hasValue(StringSE paramName)
    指定された名前付きパラメーターに値があるかどうかを判別します。

  • フィールドの詳細

  • メソッドの詳細

    • hasValue

      boolean hasValue(StringSE paramName)
      指定された名前付きパラメーターに値があるかどうかを判別します。
      パラメーター:
      paramName - パラメーターの名前
      戻り値:
      値が定義されているかどうか

    • getValue

      @Nullable ObjectSE getValue(StringSE paramName) throws IllegalArgumentExceptionSE
      リクエストされた名前付きパラメーターのパラメーター値を返します。
      パラメーター:
      paramName - パラメーターの名前
      戻り値:
      指定されたパラメーターの値
      例外:
      IllegalArgumentExceptionSE - リクエストされたパラメーターに値がない場合

    • getSqlType

      default int getSqlType(StringSE paramName)
      指定された名前付きパラメーターの SQL 型を判別します。
      パラメーター:
      paramName - パラメーターの名前
      戻り値:
      指定されたパラメーターの SQL 型、または不明の場合は TYPE_UNKNOWN 
      関連事項:

    • getTypeName

      @Nullable default StringSE getTypeName(StringSE paramName)
      指定された名前付きパラメーターの型名を決定します。
      パラメーター:
      paramName - パラメーターの名前
      戻り値:
      指定されたパラメーターの型名。不明な場合は null 

    • getParameterNames

      @Nullable default StringSE[] getParameterNames()
      可能な場合は、使用可能なすべてのパラメーター名を列挙します。

      これは、主に SimpleJdbcInsert および SimpleJdbcCall で使用するためのオプションの操作です。

      戻り値:
      パラメーター名の配列、または決定できない場合は null 
      導入:
      5.0.3
      関連事項: