6.3.15 PctoReaderクラス
- 説明
-
文字ストリームを読み込むためのクラスです。
- メソッド
-
PctoReaderクラスのメソッドの一覧を次の表に示します。
表6‒25 PctoReaderクラスのメソッドの一覧 メソッド
説明
close()
ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。
mark(int readAheadLimit)
ストリームの現在位置にマークを設定します。
markSupported()
このストリームがmark()オペレーションをサポートするかどうかを判定します。
read()
単一の文字を読み込みます。
read(char[] cbuf)
配列に文字を読み込みます。
read(char[] cbuf, int off, int len)
配列の一部に文字を読み込みます。
read(CharBuffer target)
指定された文字バッファに文字列を読み込みます。
ready()
このストリームが読み込めるかどうかを判定します。
reset()
ストリームをリセットします。
skip(long n)
文字をスキップします。
- パッケージ名称
jp.co.Hitachi.soft.hmppcto.jdbc.client
- 〈この項の構成〉
(1) close()
- 説明
-
ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。ストリームが閉じられたあとにread()、ready()、mark()、reset()、またはskip()を呼び出すと、IOExceptionがスローされます。すでに閉じられているストリームを閉じても、何の影響もありません。
- 形式
public void close() throws java.io.IOException
- 引数
-
なし。
- 戻り値
-
なし。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
入出力エラーが発生した場合に送出します。
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(2) mark(int readAheadLimit)
- 説明
-
ストリームの現在位置にマークを設定します。以降のreset()の呼び出しでは、この位置へのストリームの再配置が試みられます。
- 形式
public void mark(int readAheadLimit) throws java.io.IOException
- 引数
-
- int readAheadLimit:
-
マークを保持しながら読み込むことができる文字数の上限を指定します。この数の文字を読み込んだあとにストリームをリセットしようとすると失敗することがあります。
- 戻り値
-
なし。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
次の場合に例外を送出します。
-
ストリームがmark()をサポートしない場合
-
そのほかの入出力エラーが発生した場合
-
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(3) markSupported()
- 説明
-
このストリームがmark()オペレーションをサポートするかどうかを判定します。
- 形式
public boolean markSupported()
- 引数
-
なし。
- 戻り値
-
このストリームがmark()オペレーションをサポートする場合は、trueを返します。
- 例外
-
- java.lang.RuntimeException:
-
次の例外をcauseに設定したjava.lang.RuntimeExceptionを送出します。
-
PctoIOCommunicationFailureException
Entity-ServiceとParticipant間の通信に失敗した場合
-
PctoIOInternalContradictionException
Participantの内部で障害が発生した場合
-
PctoIOTransactionStartException
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合
-
(4) read()
- 説明
-
単一の文字を読み込みます。このメソッドは、1文字が読み込まれるか、入出力エラーが発生するか、またはストリームの終わりに達するまでブロックされます。
- 形式
public int read() throws java.io.IOException
- 引数
-
なし。
- 戻り値
-
読み込まれた文字を0 - 65535(0x00 - 0xffff)の範囲の整数で返します。ストリームの終わりに達した場合は、-1を返します。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
入出力エラーが発生した場合に送出します。
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(5) read(char[] cbuf)
- 説明
-
配列に文字を読み込みます。このメソッドは、入力の一部が有効になるか、入出力エラーが発生するか、またはストリームの終わりに達するまでブロックされます。
- 形式
public int read(char[] cbuf) throws java.io.IOException
- 引数
-
- char[] cbuf:
-
転送先バッファを指定します。
- 戻り値
-
読み込まれた文字数を返します。ストリームの終わりに達した場合は、-1を返します。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
入出力エラーが発生した場合に送出します。
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(6) read(char[] cbuf, int off, int len)
- 説明
-
配列の一部に文字を読み込みます。このメソッドは、入力の一部が有効になるか、入出力エラーが発生するか、またはストリームの終わりに達するまでブロックされます。
- 形式
public int read(char[] cbuf, int off, int len) throws java.io.IOException
- 引数
-
- char[] cbuf:
-
転送先バッファを指定します。
- int off:
-
文字の格納開始オフセットを指定します。
- int len:
-
読み込む文字の最大数を指定します。
- 戻り値
-
読み込まれた文字数を返します。ストリームの終わりに達した場合は、-1を返します。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
入出力エラーが発生した場合に送出します。
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(7) read(CharBuffer target)
- 説明
-
指定された文字バッファに文字列を読み込みます。バッファは、put操作の結果によって変更される以外は、文字列そのままのリポジトリとして使用されます。バッファのフリッピング(反転)やリワインド(巻き戻し)は行われません。
- 形式
public int read(CharBuffer target) throws java.io.IOException
- 引数
-
- CharBuffer target:
-
文字を読み込むバッファを指定します。
- 戻り値
-
バッファに追加された文字の数を返します。文字のソースが最後の位置にある場合は-1を返します。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
入出力エラーが発生した場合に送出します。
- java.lang.NullPointerException:
-
引数targetがnullである場合に送出します。
- java.nio.ReadOnlyBufferException:
-
targetが読み取り専用バッファの場合に送出します。
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(8) ready()
- 説明
-
このストリームが読み込めるかどうかを判定します。
- 形式
public boolean ready() throws java.io.IOException
- 引数
-
なし。
- 戻り値
-
次のread()が入力をブロックしないことが確実な場合はtrue、そうでない場合はfalseを返します。falseが返されても、次の読み込みが確実にブロックするというわけではありません。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
次の場合に例外を送出します。
-
入出力エラーが発生した場合
-
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(9) reset()
- 説明
-
ストリームをリセットします。ストリームにマークが設定されている場合は、マークに再配置しようとします。マークが設定されていない場合は、開始位置への再配置など、個々のストリームに適した方法でリセットを試みます。
- 形式
public void reset() throws java.io.IOException
- 引数
-
なし。
- 戻り値
-
なし。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
次の場合に例外を送出します。
-
ストリームにマークが設定されていない場合
-
マークの設定が無効な場合
-
ストリームがreset()をサポートしない場合
-
ほかの入出力エラーが発生した場合
-
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(10) skip(long n)
- 説明
-
文字をスキップします。このメソッドは、文字が読み込まれるか、入出力エラーが発生するか、またはストリームの終わりに達するまでブロックされます。
- 形式
public long skip(long n) throws java.io.IOException
- 引数
-
- long n:
-
スキップする文字数を指定します。
- 戻り値
-
実際にスキップした文字数を返します。
- 例外
-
PctoIOCommunicationFailureException例外とPctoIOInternalContradictionException例外以外は、Participantが送出した例外を送出します。
- java.io.IOException:
-
入出力エラーが発生した場合に送出します。
- java.lang.IllegalArgumentException:
-
引数nが負の値の場合に送出します。
- PctoIOCommunicationFailureException:
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoIOInternalContradictionException:
-
Participantの内部で障害が発生した場合に送出します。
- PctoIOTransactionStartException:
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。