SQLInput (Java Platform SE 7)

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

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` として返します。
`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

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

インタフェース SQLInput

メソッドのサマリー

メソッドの詳細

readString

readBoolean

readByte

readShort

readInt

readLong

readFloat

readDouble

readBigDecimal

readBytes

readDate

readTime

readTimestamp

readCharacterStream

readAsciiStream

readBinaryStream

readObject

readRef

readBlob

readClob

readArray

wasNull

readURL

readNClob

readNString

readSQLXML

readRowId