既知のすべての実装クラス:: SQLInputImpl

public interface SQLInput

SQL構造化型またはSQLの個別の型のインスタンスを表す値のストリームを格納する入力ストリームです。カスタム・マッピングにだけ使用されるこのインタフェースはドライバによって内部で使用され、SQLInputメソッドをプログラマが直接呼び出すことはありません。 readerメソッド(readLong、readBytesなど)を使用すると、SQLInputオブジェクトの値を読み込むためにSQLDataインタフェースを実装することができます。 SQLDataで説明したとおり、readerメソッドの呼出しは、対応する属性が型のSQL定義に出現する順序で行われる必要があります。最終値がSQL NULLであったかどうかの確認には、wasNullメソッドが使用されます。

getObjectメソッドがSQLDataインタフェースを実装するクラスのオブジェクトで呼び出されると、JDBCドライバはカスタム・マッピングされるユーザー定義型(UDT)のSQL型を判別するためにSQLData.getSQLTypeメソッドを呼び出します。ドライバは、SQLInputのインスタンスを作成し、UDTの属性を移植します。次に、ドライバは入力ストリームをSQLData.readSQLメソッドに渡し、SQLData.readSQLメソッドはその実装で入力ストリームから属性を読み込むためのSQLInput readerメソッドを呼び出します。

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

メソッドのサマリー

修飾子と型	メソッド	説明
`Array`	`readArray()`	ストリームからSQL `ARRAY`値を読み込み、その値をJavaプログラミング言語の`Array`オブジェクトとして返します。
`InputStream`	`readAsciiStream()`	ストリーム内の次の属性を読み込み、それをASCII文字のストリームとして返します。
`BigDecimal`	`readBigDecimal()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`java.math.BigDecimal`オブジェクトとして返します。
`InputStream`	`readBinaryStream()`	ストリーム内の次の属性を読み込み、それを未解釈のバイト・ストリームとして返します。
`Blob`	`readBlob()`	ストリームからSQL `BLOB`値を読み込み、その値をJavaプログラミング言語の`Blob`オブジェクトとして返します。
`boolean`	`readBoolean()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`boolean`として返します。
`byte`	`readByte()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`byte`として返します。
`byte[]`	`readBytes()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のバイトの配列として返します。
`Reader`	`readCharacterStream()`	ストリーム内の次の属性を読み込み、それをUnicode文字のストリームとして返します。
`Clob`	`readClob()`	ストリームからSQL `CLOB`値を読み込み、その値をJavaプログラミング言語の`Clob`オブジェクトとして返します。
`Date`	`readDate()`	ストリーム内の次の属性を読み込み、それを`java.sql.Date`オブジェクトとして返します。
`double`	`readDouble()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`double`として返します。
`float`	`readFloat()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`float`として返します。
`int`	`readInt()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`int`として返します。
`long`	`readLong()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`long`として返します。
`NClob`	`readNClob()`	ストリームからSQL `NCLOB`値を読み込み、その値をJavaプログラミング言語の`NClob`オブジェクトとして返します。
`String`	`readNString()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`String`として返します。
`Object`	`readObject()`	ストリームの先頭にあるデータを読み込み、それをJavaプログラミング言語の`Object`として返します。
`default <T> T`	`readObject(Class<T> type)`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`Object`として返します。
`Ref`	`readRef()`	ストリームからSQL `REF`値を読み込み、その値をJavaプログラミング言語の`Ref`オブジェクトとして返します。
`RowId`	`readRowId()`	ストリームからSQL `ROWID`値を読み込み、その値をJavaプログラミング言語の`RowId`オブジェクトとして返します。
`short`	`readShort()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`short`として返します。
`SQLXML`	`readSQLXML()`	ストリームからSQL `XML`値を読み込み、その値をJavaプログラミング言語の`SQLXML`オブジェクトとして返します。
`String`	`readString()`	ストリーム内の次の属性を読み込み、それをJavaプログラミング言語の`String`として返します。
`Time`	`readTime()`	ストリーム内の次の属性を読み込み、それを`java.sql.Time`オブジェクトとして返します。
`Timestamp`	`readTimestamp()`	ストリーム内の次の属性を読み込み、それを`java.sql.Timestamp`オブジェクトとして返します。
`URL`	`readURL()`	ストリームからSQL `DATALINK`値を読み込み、その値をJavaプログラミング言語の`java.net.URL`オブジェクトとして返します。
`boolean`	`wasNull()`	最後に読み込まれた値がSQL `NULL`かどうかを取得します。

メソッドの詳細
- readString
  
  String readString() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のStringとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readBoolean
  
  boolean readBoolean() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のbooleanとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はfalseを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readByte
  
  byte readByte() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のbyteとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合は0を返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readShort
  
  short readShort() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のshortとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合は0を返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readInt
  
  int readInt() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のintとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合は0を返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readLong
  
  long readLong() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のlongとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合は0を返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readFloat
  
  float readFloat() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のfloatとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合は0を返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readDouble
  
  double readDouble() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のdoubleとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合は0を返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readBigDecimal
  
  BigDecimal readBigDecimal() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のjava.math.BigDecimalオブジェクトとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readBytes
  
  byte[] readBytes() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のバイトの配列として返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readDate
  
  Date readDate() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをjava.sql.Dateオブジェクトとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readTime
  
  Time readTime() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをjava.sql.Timeオブジェクトとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readTimestamp
  
  Timestamp readTimestamp() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをjava.sql.Timestampオブジェクトとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readCharacterStream
  
  Reader readCharacterStream() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをUnicode文字のストリームとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readAsciiStream
  
  InputStream readAsciiStream() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをASCII文字のストリームとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readBinaryStream
  
  InputStream readBinaryStream() throws SQLException
  
  ストリーム内の次の属性を読み込み、それを未解釈のバイト・ストリームとして返します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readObject
  
  Object readObject() throws SQLException
  
  ストリームの先頭にあるデータを読み込み、それをJavaプログラミング言語のObjectとして返します。返されるオブジェクトの実際の型は、デフォルトの型マップおよびこのストリームのこのストリームの型マップに示されるカスタマイズによって判定されます。
  型マップはストリームがアプリケーションに渡される前にJDBCドライバによってストリームに登録されます。
  ストリームの先頭にあるデータがSQL NULLの場合、このメソッドはnullを返します。データがSQL構造化型または個別の型の場合は、ストリームの先頭にあるデータのSQL型を判定します。ストリームの型マップにSQL型のエントリがある場合は、ドライバは適切なクラスのオブジェクトを構築してから、そのオブジェクトでSQLData.readSQLメソッドを呼び出します。SQLData.readSQLメソッドはそのメソッドのために記述されたプロトコルを使用して、ストリームから追加データを読み込みます。
  
  戻り値:
  
  ストリームの先頭にあるJavaプログラミング言語のObjectとしてのデータ。データがSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readRef
  
  Ref readRef() throws SQLException
  
  ストリームからSQL REF値を読み込み、その値をJavaプログラミング言語のRefオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL REF値を表すRefオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readBlob
  
  Blob readBlob() throws SQLException
  
  ストリームからSQL BLOB値を読み込み、その値をJavaプログラミング言語のBlobオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL BLOB値のデータを表すBlobオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readClob
  
  Clob readClob() throws SQLException
  
  ストリームからSQL CLOB値を読み込み、その値をJavaプログラミング言語のClobオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL CLOB値のデータを表すClobオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readArray
  
  Array readArray() throws SQLException
  
  ストリームからSQL ARRAY値を読み込み、その値をJavaプログラミング言語のArrayオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL ARRAY値のデータを表すArrayオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- wasNull
  
  boolean wasNull() throws SQLException
  
  最後に読み込まれた値がSQL NULLかどうかを取得します。
  
  戻り値:
  
  最後に読み込まれたSQL値がSQL NULLの場合はtrue、そうでない場合はfalse
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.2
- readURL
  
  URL readURL() throws SQLException
  
  ストリームからSQL DATALINK値を読み込み、その値をJavaプログラミング言語のjava.net.URLオブジェクトとして返します。
  
  戻り値:
  
  java.net.URLオブジェクト。
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合、またはURLが無効の場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.4
- readNClob
  
  NClob readNClob() throws SQLException
  
  ストリームからSQL NCLOB値を読み込み、その値をJavaプログラミング言語のNClobオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL NCLOB値のデータを表すNClobオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.6
- readNString
  
  String readNString() throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のStringとして返します。 NCHAR、NVARCHAR、およびLONGNVARCHAR列にアクセスするときに使用します。
  
  戻り値:
  
  属性。値がSQL NULLの場合はnullを返す
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.6
- readSQLXML
  
  SQLXML readSQLXML() throws SQLException
  
  ストリームからSQL XML値を読み込み、その値をJavaプログラミング言語のSQLXMLオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL XML値のデータを表すSQLXMLオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.6
- readRowId
  
  RowId readRowId() throws SQLException
  
  ストリームからSQL ROWID値を読み込み、その値をJavaプログラミング言語のRowIdオブジェクトとして返します。
  
  戻り値:
  
  ストリームの先頭にあるSQL ROWID値のデータを表すRowIdオブジェクト。読み込まれた値がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.6
- readObject
  
  default <T> T readObject(Class<T> type) throws SQLException
  
  ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のObjectとして返します。返されるオブジェクトの実際の型は、指定されたJavaデータ型およびこのストリームの型マップに示されるカスタマイズによって判定されます。
  型マップはストリームがアプリケーションに渡される前にJDBCドライバによってストリームに登録されます。
  ストリームの先頭にある属性がSQL NULLの場合、このメソッドはnullを返します。属性がSQL構造化型または個別の型の場合は、ストリームの先頭にある属性のSQL型を判定します。ストリームの型マップにSQL型のエントリがある場合は、ドライバは適切なクラスのオブジェクトを構築してから、そのオブジェクトでSQLData.readSQLメソッドを呼び出します。SQLData.readSQLメソッドはそのメソッドのために記述されたプロトコルを使用して、ストリームから追加データを読み込みます。
  デフォルト実装はSQLFeatureNotSupportedExceptionをスローします
  
  型パラメータ:
  
  T - このClassオブジェクトでモデル化されるクラスの型
  
  パラメータ:
  
  type - 属性の変換後のJavaデータ型を表すクラス。
  
  戻り値:
  
  ストリームの先頭にあるJavaプログラミング言語のObjectとしての属性。属性がSQL NULLの場合はnull
  
  例外:
  
  SQLException - データベース・アクセス・エラーが発生した場合
  
  SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
  
  導入されたバージョン:
  
  1.8

インタフェースSQLInput

メソッドのサマリー

メソッドの詳細