モジュール java.sql
パッケージ java.sql

インタフェースSQLOutput

既知のすべての実装クラス:
SQLOutputImpl
public interface SQLOutput
ユーザー定義型の属性をデータベースに書き戻すための出力ストリームです。 カスタム・マッピングにだけ使用されるこのインタフェースはドライバによって使用され、そのメソッドをプログラマが直接呼び出すことはありません。

SQLDataインタフェースを実装するクラスのオブジェクトが引数としてSQL文に渡されると、JDBCドライバはデータベースに渡されるSQLデータの種類を判定するためにSQLData.getSQLTypeメソッドを呼び出します。 次に、ドライバはSQLOutputのインスタンスを生成し、それをSQLData.writeSQLメソッドに渡します。 writeSQLメソッドは、SQLDataオブジェクトからSQLOutput出力ストリームにデータをSQLユーザー定義型の表現として書き込むための適切なSQLOutput writerメソッド(writeBoolean、writeCharacterStreamなど)を呼び出します。

導入されたバージョン:
1.2

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    void writeArray​(Array x)
    SQL ARRAY値をストリームに書き込みます。
    void writeAsciiStream​(InputStream x)
    次の属性をASCII文字のストリームとしてストリームに書き込みます。
    void writeBigDecimal​(BigDecimal x)
    次の属性をjava.math.BigDecimalオブジェクトとしてストリームに書き込みます。
    void writeBinaryStream​(InputStream x)
    次の属性を未解釈のバイト・ストリームとしてストリームに書き込みます。
    void writeBlob​(Blob x)
    SQL BLOB値をストリームに書き込みます。
    void writeBoolean​(boolean x)
    次の属性をJavaのboolean型としてストリームに書き込みます。
    void writeByte​(byte x)
    次の属性をJavaのbyte型としてストリームに書き込みます。
    void writeBytes​(byte[] x)
    次の属性をbyte型の配列としてストリームに書き込みます。
    void writeCharacterStream​(Reader x)
    次の属性をUnicode文字のストリームとしてストリームに書き込みます。
    void writeClob​(Clob x)
    SQL CLOB値をストリームに書き込みます。
    void writeDate​(Date x)
    次の属性をjava.sql.Dateオブジェクトとしてストリームに書き込みます。
    void writeDouble​(double x)
    次の属性をJavaのdouble型としてストリームに書き込みます。
    void writeFloat​(float x)
    次の属性をJavaのfloat型としてストリームに書き込みます。
    void writeInt​(int x)
    次の属性をJavaのint型としてストリームに書き込みます。
    void writeLong​(long x)
    次の属性をJavaのlong型としてストリームに書き込みます。
    void writeNClob​(NClob x)
    SQL NCLOB値をストリームに書き込みます。
    void writeNString​(String x)
    次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
    default void writeObject​(Object x, SQLType targetSqlType)
    指定されたオブジェクトに格納されたデータをストリームに書き込みます。
    void writeObject​(SQLData x)
    指定されたSQLDataオブジェクトに格納されたデータをストリームに書き込みます。
    void writeRef​(Ref x)
    SQL REF値をストリームに書き込みます。
    void writeRowId​(RowId x)
    SQL ROWID値をストリームに書き込みます。
    void writeShort​(short x)
    次の属性をJavaのshort型としてストリームに書き込みます。
    void writeSQLXML​(SQLXML x)
    SQL XML値をストリームに書き込みます。
    void writeString​(String x)
    次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
    void writeStruct​(Struct x)
    SQL構造化型値をストリームに書き込みます。
    void writeTime​(Time x)
    次の属性をjava.sql.Timeオブジェクトとしてストリームに書き込みます。
    void writeTimestamp​(Timestamp x)
    次の属性をjava.sql.Timestampオブジェクトとしてストリームに書き込みます。
    void writeURL​(URL x)
    SQL DATALINK値をストリームに書き込みます。

  • メソッドの詳細

    • writeString

      void writeString​(String x) throws SQLException
      次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeBoolean

      void writeBoolean​(boolean x) throws SQLException
      次の属性をJavaのboolean型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeByte

      void writeByte​(byte x) throws SQLException
      次の属性をJavaのbyte型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeShort

      void writeShort​(short x) throws SQLException
      次の属性をJavaのshort型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeInt

      void writeInt​(int x) throws SQLException
      次の属性をJavaのint型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeLong

      void writeLong​(long x) throws SQLException
      次の属性をJavaのlong型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeFloat

      void writeFloat​(float x) throws SQLException
      次の属性をJavaのfloat型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeDouble

      void writeDouble​(double x) throws SQLException
      次の属性をJavaのdouble型としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeBigDecimal

      void writeBigDecimal​(BigDecimal x) throws SQLException
      次の属性をjava.math.BigDecimalオブジェクトとしてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeBytes

      void writeBytes​(byte[] x) throws SQLException
      次の属性をbyte型の配列としてストリームに書き込みます。 次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeDate

      void writeDate​(Date x) throws SQLException
      次の属性をjava.sql.Dateオブジェクトとしてストリームに書き込みます。 次の属性をJavaプログラミング言語のjava.sql.Dateオブジェクトとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeTime

      void writeTime​(Time x) throws SQLException
      次の属性をjava.sql.Timeオブジェクトとしてストリームに書き込みます。 次の属性をJavaプログラミング言語のjava.sql.Dateオブジェクトとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeTimestamp

      void writeTimestamp​(Timestamp x) throws SQLException
      次の属性をjava.sql.Timestampオブジェクトとしてストリームに書き込みます。 次の属性をJavaプログラミング言語のjava.sql.Dateオブジェクトとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeCharacterStream

      void writeCharacterStream​(Reader x) throws SQLException
      次の属性をUnicode文字のストリームとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeAsciiStream

      void writeAsciiStream​(InputStream x) throws SQLException
      次の属性をASCII文字のストリームとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeBinaryStream

      void writeBinaryStream​(InputStream x) throws SQLException
      次の属性を未解釈のバイト・ストリームとしてストリームに書き込みます。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeObject

      void writeObject​(SQLData x) throws SQLException
      指定されたSQLDataオブジェクトに格納されたデータをストリームに書き込みます。 SQLDataオブジェクトがnullの場合、このメソッドはSQL NULLをストリームに書き込みます。 そうでない場合は、指定されたオブジェクトのSQLData.writeSQLメソッドを呼び出します。すると、呼び出されたメソッドによって、オブジェクトの属性がストリームに書き込まれます。 SQLData.writeSQLメソッドの実装は、オブジェクトの各属性を正しい順序で書き込むための適切なSQLOutput writerメソッド(複数可)を呼び出します。 属性は、SQLInput入力ストリームから読み込まれ、ユーザー定義型のSQL定義にリストされたときと同じ順序でSQLOutput出力ストリームに書き込まれる必要があります。
      パラメータ:
      x - SQL構造化型または個別の型のデータを表すオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeRef

      void writeRef​(Ref x) throws SQLException
      SQL REF値をストリームに書き込みます。
      パラメータ:
      x - SQL REF値のデータを表すRefオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeBlob

      void writeBlob​(Blob x) throws SQLException
      SQL BLOB値をストリームに書き込みます。
      パラメータ:
      x - SQL BLOB値のデータを表すBlobオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeClob

      void writeClob​(Clob x) throws SQLException
      SQL CLOB値をストリームに書き込みます。
      パラメータ:
      x - SQL CLOB値のデータを表すClobオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeStruct

      void writeStruct​(Struct x) throws SQLException
      SQL構造化型値をストリームに書き込みます。
      パラメータ:
      x - SQL構造化型のデータを表すStructオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeArray

      void writeArray​(Array x) throws SQLException
      SQL ARRAY値をストリームに書き込みます。
      パラメータ:
      x - SQLARRAY型のデータを表すArrayオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • writeURL

      void writeURL​(URL x) throws SQLException
      SQL DATALINK値をストリームに書き込みます。
      パラメータ:
      x - SQL DATALINK型のデータを表すjava.net.URLオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.4

    • writeNString

      void writeNString​(String x) throws SQLException
      次の属性をJavaプログラミング言語のStringとしてストリームに書き込みます。 ストリームに送るときに、ドライバはこれをNCHAR、NVARCHAR、またはLONGNVARCHAR値(ドライバのNVARCHAR値に関する制限に関する引数のサイズに依存)に変換します。
      パラメータ:
      x - データベースに渡す値
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.6

    • writeNClob

      void writeNClob​(NClob x) throws SQLException
      SQL NCLOB値をストリームに書き込みます。
      パラメータ:
      x - SQL NCLOB値のデータを表すNClobオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.6

    • writeRowId

      void writeRowId​(RowId x) throws SQLException
      SQL ROWID値をストリームに書き込みます。
      パラメータ:
      x - SQL ROWID値のデータを表すRowIdオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.6

    • writeSQLXML

      void writeSQLXML​(SQLXML x) throws SQLException
      SQL XML値をストリームに書き込みます。
      パラメータ:
      x - SQL XML値のデータを表すSQLXMLオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合、SQLXMLオブジェクト用のjava.xml.transform.Result、Writer、またはOutputStreamがクローズされていない場合、あるいはXML値の処理中にエラーが発生した場合。 この例外のgetCauseメソッドにより、より詳細な例外が提供されることがある(たとえばストリームに有効なXMLが含まれていない場合)。
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.6

    • writeObject

      default void writeObject​(Object x, SQLType targetSqlType) throws SQLException
      指定されたオブジェクトに格納されたデータをストリームに書き込みます。 このオブジェクトは、ストリームに送られる前に、指定されたtargetSqlTypeに変換されます。

      objectがnullの場合、このメソッドはSQL NULLをストリームに書き込みます。

      オブジェクトがカスタム・マッピングを持つ場合(オブジェクトがインタフェースSQLDataを実装するクラスのインスタンスである場合)、JDBCドライバはSQLData.writeSQLメソッドを呼び出して、そのオブジェクトをSQLデータ・ストリームへ書き込む必要があります。 また、オブジェクトがRef、Blob、Clob、NClob、Struct、java.net.URL、またはArrayを実装するクラスのオブジェクトである場合、ドライバはこのオブジェクトを対応するSQL型の値としてデータベースに渡す必要があります。

      デフォルト実装はSQLFeatureNotSupportedExceptionをスローします

      パラメータ:
      x - 入力パラメータ値を含むオブジェクト
      targetSqlType - データベースに送られるSQL型。
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合、またはxで指定されたJavaオブジェクトがInputStreamオブジェクトかReaderオブジェクトで、かつscaleパラメータの値が0より小さい場合
      SQLFeatureNotSupportedException - JDBCドライバがこのデータ型をサポートしない場合
      導入されたバージョン:
      1.8
      関連項目:
      JDBCType, SQLType