BytesMessageインタフェース(JMS)
BytesMessageインタフェースは,解釈されていないバイトストリームを含むメッセージを送信するために使用します。
形式
public interface BytesMessage extends Message { public boolean readBoolean() throws JMSException; public byte readByte() throws JMSException; public int readUnsignedByte() throws JMSException; public short readShort() throws JMSException; public int readUnsignedShort() throws JMSException; public char readChar() throws JMSException; public int readInt() throws JMSException; public long readLong() throws JMSException; public float readFloat() throws JMSException; public double readDouble() throws JMSException; public java.lang.String readUTF() throws JMSException; public int readBytes(byte[] value) throws JMSException; public int readBytes(byte[] value, int length) throws JMSException; public void writeBoolean(boolean value) throws JMSException; public void writeByte(byte value) throws JMSException; public void writeShort(short value) throws JMSException; public void writeChar(char value) throws JMSException; public void writeInt(int value) throws JMSException; public void writeLong(long value) throws JMSException; public void writeFloat(float value) throws JMSException; public void writeDouble(double value) throws JMSException; public void writeUTF(java.lang.String value) throws JMSException; public void writeBytes(byte[] value) throws JMSException; public void writeBytes(byte[] value, int offset, int length) throws JMSException; public void writeObject(java.lang.Object value) throws JMSException; public void reset() throws JMSException; }
メソッド
● public boolean readBoolean() throws JMSException
バイトメッセージストリームからboolean型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:boolean型の値
● public byte readByte() throws JMSException
バイトメッセージストリームから符号付き8ビット型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の1バイトを符号付き8ビット型と解釈した値
● public int readUnsignedByte() throws JMSException
バイトメッセージストリームから符号なし8ビット型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の1バイトを符号なし8ビット型と解釈した値
● public short readShort() throws JMSException
バイトメッセージストリームから符号付き16ビット型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の2バイトを符号付き16ビット型と解釈した値
● public int readUnsignedShort() throws JMSException
バイトメッセージストリームから符号なし16ビット型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の2バイトを符号なし16ビット型と解釈した値
● public char readChar() throws JMSException
バイトメッセージストリームからUnicode文字列を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の2バイトをUnicode文字列と解釈した値
● public int readInt() throws JMSException
バイトメッセージストリームから符号付き32ビット型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の4バイトを符号付き32ビット型と解釈した値
● public long readLong() throws JMSException
バイトメッセージストリームから符号付き64ビット型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の8バイトを符号付き64ビット型と解釈した値
● public float readFloat() throws JMSException
バイトメッセージストリームからfloat型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の4バイトをfloat型と解釈した値
● public double readDouble() throws JMSException
バイトメッセージストリームからdouble型の値を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:次の8バイトをdouble型と解釈した値
● public java.lang.String readUTF() throws JMSException
バイトメッセージストリームから修正UTF-8フォーマットを使用してエンコードされた文字列を取得します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
MessageEOFException:メッセージの終端に達しました。
戻り値:Unicode文字列と解釈した値
● public int readBytes(byte[] value) throws JMSException
バイトメッセージストリームからbyte型配列の値を取得します。
バイトメッセージストリームから読み込まれる残りのバイトより,配列の長さが小さい場合,配列は満たされます。この場合は,あとの呼び出しで次の増分が読み込まれます。一方,バイトメッセージストリームから読み込まれる残りのバイトより,配列の長さが大きい場合,残りのバイトデータは配列に読み込まれます。
戻り値がbyte型配列の長さより小さい場合は,バイトメッセージストリームにデータが残っていないことを示します。この場合は,次の読み込みで-1が返ります。
- パラメタ
-
- value
-
バイトメッセージストリームから読み込んだデータを指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
- 戻り値:バッファから入力した総バイト数
-
ストリームの終端に達して,これ以上データがない場合は-1が返ります。
● public int readBytes(byte[] value, int length) throws JMSException
バイトメッセージストリームからbyte型配列の値の一部を取得します。
バイトメッセージストリームから読み込まれる残りのバイトよりlengthが小さい場合,読み込まれたデータは配列にlengthの長さまで格納されます。この場合は,あとの呼び出しで次の増分が読み込まれます。一方,バイトメッセージストリームから読み込まれる残りのバイトよりlengthが大きい場合,残りのバイトデータは配列に読み込まれます。
戻り値がlengthより小さい場合は,バイトメッセージストリームにデータが残っていないことを示します。この場合は,次の読み込みで-1が返ります。
lengthの値が負の場合,または配列の長さより大きい場合は,例外JMSExceptionがスローされます。例外がスローされると,バイトメッセージストリームからデータは読み込まれません。
- パラメタ
-
- value
-
バイトメッセージストリームから読み込んだデータを指定します。
- length
-
読み込むデータのバイト長を指定します。配列の長さと等しい,または小さい値を指定してください。
- 例外
-
JMSException:エラーが発生しました。
MessageNotReadableException:メッセージは書き込み専用です。
- 戻り値:バッファから入力した総バイト数
-
ストリームの終端に達して,これ以上データがない場合は-1が返ります。
● public void writeBoolean(boolean value) throws JMSException
1バイトの値として,boolean型の値をバイトメッセージストリームに書き込みます。trueの場合は1の値,falseの場合は0の値を書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeByte(byte value) throws JMSException
1バイトの値として,byte型の値をバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeShort(short value) throws JMSException
2バイトの値として,short型の値をhigh byte firstでバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeChar(char value) throws JMSException
2バイトの値として,char型の値をhigh byte firstでバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeInt(int value) throws JMSException
4バイトの値として,int型の値をhigh byte firstでバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeLong(long value) throws JMSException
8バイトの値として,long型の値をhigh byte firstでバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeFloat(float value) throws JMSException
FloatクラスのfloatToIntBitsメソッドを使用して,float型の値をint型に変換します。その後,4バイトの値として,変換したint型の値をhigh byte firstでバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeDouble(double value) throws JMSException
DoubleクラスのdoubleToLongBitsメソッドを使用して,double型の値をlong型に変換します。その後,8バイトの値として,変換したlong型の値をhigh byte firstでバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeUTF(java.lang.String value) throws JMSException
修正UTF-8フォーマットを使用してエンコードされた文字列をバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeBytes(byte[] value) throws JMSException
byte型配列をバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeBytes(byte[] value, int offset, int length) throws JMSException
byte型配列の一部をバイトメッセージストリームに書き込みます。
- パラメタ
-
- value
-
書き込む値を指定します。
- offset
-
byte型配列内の初期のオフセットを指定します。
- length
-
書き込むバイト数を指定します。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
● public void writeObject(java.lang.Object value) throws JMSException
Javaオブジェクトをバイトメッセージストリームに書き込みます。書き込みできる値の型は,プリミティブ型をラップするクラス(Byte,Integerなど),String型,およびbyte型配列です。
- パラメタ
-
- value
-
書き込むJavaオブジェクトの値を指定します。null値は指定できません。
- 例外
-
JMSException:エラーが発生しました。
MessageNotWriteableException:メッセージは読み込み専用です。
NullPointerException:パラメタがnull値です。
MessageFormatException:オブジェクトの型が不正です。
● public void reset() throws JMSException
メッセージ本体を読み込み専用にして,バイトメッセージストリームを最初の位置に変更します。
- 例外
-
JMSException:エラーが発生しました。
MessageFormatException:メッセージのフォーマットが不正です。