インターフェース BytesMessage
- すべてのスーパーインターフェース:
- Message
 - public interface BytesMessage extends Message - BytesMessageオブジェクトは、未解釈のバイトのストリームを含むメッセージを送信するために使用されます。- Messageインターフェースから継承し、バイトメッセージ本文を追加します。メッセージの受信側は、バイトの解釈を提供します。- BytesMessageメソッドは、主に- java.io.DataInputStreamおよび- java.io.DataOutputStreamにあるメソッドに基づいています。- このメッセージ型は、既存のメッセージフォーマットのクライアントエンコーディング用です。可能であれば、代わりに他の自己定義メッセージ型の 1 つを使用する必要があります。 - Jakarta Messaging API ではバイトメッセージでメッセージプロパティを使用できますが、プロパティを含めると形式に影響する可能性があるため、通常は使用されません。 - プリミティブ型は、各型のメソッドを使用して明示的に書くことができます。それらは一般的にオブジェクトとして書かれることもあります。たとえば、 - BytesMessage.writeInt(6)の呼び出しは- BytesMessage.writeObject(new Integer(6))と同等です。明示的なフォームは静的プログラミングに便利であり、コンパイル時に型が不明な場合はオブジェクトフォームが必要であるため、両方のフォームが提供されます。- メッセージが最初に作成されたとき、および - clearBodyが呼び出されたとき、メッセージの本文は書き込み専用モードです。- resetへの最初の呼び出しが行われた後、メッセージ本文は読み取り専用モードになります。- BytesMessageが非同期で送信される場合、プロバイダーは- CompletionListenerに渡された- BytesMessageで- resetを呼び出す必要があります。これは、- CompletionListenerが- resetを呼び出す必要なくメッセージ本文を読み取ることができることを意味します。メッセージが送信された後、メッセージを送信したクライアントは、送信されたメッセージに影響を与えることなく、メッセージを保持および変更できます。同じメッセージオブジェクトを複数回送信できます。メッセージが受信されると、プロバイダーは- resetを呼び出して、メッセージ本文がクライアントに対して読み取り専用モードになるようにしました。- 読み取り専用モードのメッセージで - clearBodyが呼び出されると、メッセージ本文はクリアされ、メッセージは書き込み専用モードになります。- クライアントが書き込み専用モードでメッセージを読み取ろうとすると、 - MessageNotReadableExceptionがスローされます。- クライアントが読み取り専用モードでメッセージを書き込もうとすると、 - MessageNotWriteableExceptionがスローされます。- 導入:
- JMS 1.0
- バージョン:
- Jakarta Messaging 2.0
- 関連事項:
- Session.createBytesMessage(),- MapMessage,- Message,- ObjectMessage,- StreamMessage,- TextMessage
 
- フィールドのサマリー- インターフェース jakarta.jms.Message から継承されたフィールド- DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
 
 - メソッドのサマリー- すべてのメソッド インスタンスメソッド 抽象メソッド - 修飾子と型 - メソッド - 説明 - long- getBodyLength()メッセージが読み取り専用モードの場合のメッセージ本文のバイト数を取得します。- boolean- readBoolean()バイトメッセージストリームから- booleanを読み取ります。- byte- readByte()バイトメッセージストリームから符号付き 8 ビット値を読み取ります。- int- readBytes(byte[] value)バイトメッセージストリームからバイト配列を読み取ります。- int- readBytes(byte[] value, int length)バイトメッセージストリームの一部を読み取ります。- char- readChar()バイトメッセージストリームから Unicode 文字値を読み取ります。- double- readDouble()バイトメッセージストリームから- doubleを読み取ります。- float- readFloat()バイトメッセージストリームから- floatを読み取ります。- int- readInt()バイトメッセージストリームから符号付き 32 ビット整数を読み取ります。- long- readLong()バイトメッセージストリームから符号付き 64 ビット整数を読み取ります。- short- readShort()バイトメッセージストリームから符号付き 16 ビット数値を読み取ります。- int- readUnsignedByte()バイトメッセージストリームから符号なし 8 ビット数値を読み取ります。- int- readUnsignedShort()バイトメッセージストリームから符号なし 16 ビット数を読み取ります。- StringSE- readUTF()バイトメッセージストリームから、変更された UTF-8 形式を使用してエンコードされた文字列を読み取ります。- void- reset()メッセージ本文を読み取り専用モードにして、バイトストリームを先頭に再配置します。- void- writeBoolean(boolean value)- booleanを 1 バイトの値としてバイトメッセージストリームに書き込みます。- void- writeByte(byte value)- byteを 1 バイトの値としてバイトメッセージストリームに書き込みます。- void- writeBytes(byte[] value)バイト配列をバイトメッセージストリームに書き込みます。- void- writeBytes(byte[] value, int offset, int length)バイト配列の一部をバイトメッセージストリームに書き込みます。- void- writeChar(char value)- charを 2 バイト値としてバイトメッセージストリームに書き込みます。- void- writeDouble(double value)- Doubleクラスの- doubleToLongBitsメソッドを使用して、- double引数を- longに変換し、その- long値を 8 バイトの量として、上位バイトから先にバイトメッセージストリームに書き込みます。- void- writeFloat(float value)- Floatクラスの- floatToIntBitsメソッドを使用して- float引数を- intに変換し、その- int値を 4 バイトの量として、上位バイトから先にバイトメッセージストリームに書き込みます。- void- writeInt(int value)- intを 4 バイトとしてバイトメッセージストリームに書き込みます。- void- writeLong(long value)- longを 8 バイトとして、上位バイトを先にバイトメッセージストリームに書き込みます。- void- writeObject(ObjectSE value)オブジェクトをバイトメッセージストリームに書き込みます。- void- writeShort(short value)- shortを 2 バイトとしてバイトメッセージストリームに書き込みます。- void- writeUTF(StringSE value)マシンに依存しない方法で UTF-8 エンコーディングを使用して、バイトメッセージストリームに文字列を書き込みます。- インターフェース jakarta.jms.Message から継承されたメソッド- acknowledge, clearBody, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isBodyAssignableTo, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
 
 
- メソッドの詳細- getBodyLength- long getBodyLength() throws JMSExceptionメッセージが読み取り専用モードの場合のメッセージ本文のバイト数を取得します。返された値を使用して、バイト配列を割り当てることができます。返される値は、メッセージを読み取るためのポインターが現在どこにあるかに関係なく、メッセージ本文の全長です。- 戻り値:
- メッセージのバイト数
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
- 導入:
- JMS 1.1
 
 - readBoolean- boolean readBoolean() throws JMSExceptionバイトメッセージストリームから- booleanを読み取ります。- 戻り値:
-  読み込まれた boolean値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readByte- byte readByte() throws JMSExceptionバイトメッセージストリームから符号付き 8 ビット値を読み取ります。- 戻り値:
-  署名された 8 ビット byteとしてのバイトメッセージストリームからの次のバイト
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readUnsignedByte- int readUnsignedByte() throws JMSExceptionバイトメッセージストリームから符号なし 8 ビット数値を読み取ります。- 戻り値:
- バイトメッセージストリームの次のバイト。符号なし 8 ビット数として解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readShort- short readShort() throws JMSExceptionバイトメッセージストリームから符号付き 16 ビット数値を読み取ります。- 戻り値:
- バイトメッセージストリームの次の 2 バイト。符号付き 16 ビット数として解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readUnsignedShort- int readUnsignedShort() throws JMSExceptionバイトメッセージストリームから符号なし 16 ビット数を読み取ります。- 戻り値:
- バイトメッセージストリームの次の 2 バイト。符号なし 16 ビット整数として解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readChar- char readChar() throws JMSExceptionバイトメッセージストリームから Unicode 文字値を読み取ります。- 戻り値:
- Unicode メッセージとしてのバイトメッセージストリームの次の 2 バイト
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readInt- int readInt() throws JMSExceptionバイトメッセージストリームから符号付き 32 ビット整数を読み取ります。- 戻り値:
-  バイトメッセージストリームの次の 4 バイト。intとして解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readLong- long readLong() throws JMSExceptionバイトメッセージストリームから符号付き 64 ビット整数を読み取ります。- 戻り値:
-  バイトメッセージストリームの次の 8 バイト。longとして解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readFloat- float readFloat() throws JMSExceptionバイトメッセージストリームから- floatを読み取ります。- 戻り値:
-  バイトメッセージストリームの次の 4 バイト。floatとして解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readDouble- double readDouble() throws JMSExceptionバイトメッセージストリームから- doubleを読み取ります。- 戻り値:
-  バイトメッセージストリームの次の 8 バイト。doubleとして解釈されます
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readUTF- StringSE readUTF() throws JMSException バイトメッセージストリームから、変更された UTF-8 形式を使用してエンコードされた文字列を読み取ります。- UTF-8 形式の詳細については、「ファイルシステムの安全な UCS 変換形式(FSS_UTF)」、X/Open 暫定仕様、X/Open Company Ltd.、ドキュメント番号: P316 を参照してください。この情報は、ISO/IEC 10646、Annex P にも記載されています。 - 戻り値:
- バイトメッセージストリームからの Unicode 文字列
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageEOFException- 予期しないバイトストリームの終わりに達した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readBytes- int readBytes(byte[] value) throws JMSExceptionバイトメッセージストリームからバイト配列を読み取ります。- 配列 - valueの長さがストリームから読み取られる残りのバイト数より短い場合は、配列を埋める必要があります。以降の呼び出しでは、次の増分が読み取られます。- ストリームに残っているバイト数が配列 - valueの長さより短い場合、バイトを配列に読み込む必要があります。読み取られた合計バイト数の戻り値は配列の長さよりも小さく、ストリームから読み取るバイトが残っていないことを示します。ストリームの次の読み取りは -1 を返します。- パラメーター:
- value- データが読み込まれるバッファ
- 戻り値:
- バッファーに読み込まれたバイトの総数、またはストリームの終わりに達したためにデータがない場合は -1
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - readBytes- int readBytes(byte[] value, int length) throws JMSExceptionバイトメッセージストリームの一部を読み取ります。- 配列 - valueの長さがストリームから読み取られる残りのバイト数より短い場合は、配列を埋める必要があります。以降の呼び出しでは、次の増分が読み取られます。- ストリームに残っているバイト数が配列 - valueの長さより短い場合、バイトを配列に読み込む必要があります。読み取られた合計バイト数の戻り値は配列の長さよりも小さく、ストリームから読み取るバイトが残っていないことを示します。ストリームの次の読み取りは -1 を返します。- lengthが負の場合、または- lengthが配列- valueの長さより大きい場合、- IndexOutOfBoundsExceptionがスローされます。この例外の場合、ストリームからバイトは読み取られません。- パラメーター:
- value- データが読み込まれるバッファ
- length- 読み取るバイト数。- value.length以下である必要があります
- 戻り値:
- バッファーに読み込まれたバイトの総数、またはストリームの終わりに達したためにデータがない場合は -1
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
- MessageNotReadableException- メッセージが書き込み専用モードの場合。
 
 - writeBoolean- void writeBoolean(boolean value) throws JMSException- booleanを 1 バイトの値としてバイトメッセージストリームに書き込みます。値- trueは値- (byte)1として書き込まれます。値- falseは値- (byte)0として書き込まれます。- パラメーター:
- value- 書き込まれる- boolean値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeByte- void writeByte(byte value) throws JMSException- byteを 1 バイトの値としてバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込まれる- byte値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeShort- void writeShort(short value) throws JMSException- shortを 2 バイトとしてバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込む- short
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeChar- void writeChar(char value) throws JMSException- charを 2 バイト値としてバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込まれる- char値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeInt- void writeInt(int value) throws JMSException- intを 4 バイトとしてバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込む- int
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeLong- void writeLong(long value) throws JMSException- longを 8 バイトとして、上位バイトを先にバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込む- long
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeFloat- void writeFloat(float value) throws JMSException- Floatクラスの- floatToIntBitsメソッドを使用して- float引数を- intに変換し、その- int値を 4 バイトの量として、上位バイトから先にバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込まれる- float値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeDouble- void writeDouble(double value) throws JMSException- Doubleクラスの- doubleToLongBitsメソッドを使用して、- double引数を- longに変換し、その- long値を 8 バイトの量として、上位バイトから先にバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込まれる- double値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeUTF- void writeUTF(StringSE value) throws JMSException マシンに依存しない方法で UTF-8 エンコーディングを使用して、バイトメッセージストリームに文字列を書き込みます。- UTF-8 形式の詳細については、「ファイルシステムの安全な UCS 変換形式(FSS_UTF)」、X/Open 暫定仕様、X/Open Company Ltd.、ドキュメント番号: P316 を参照してください。この情報は、ISO/IEC 10646、Annex P にも記載されています。 - パラメーター:
- value- 書き込まれる- String値
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeBytes- void writeBytes(byte[] value) throws JMSExceptionバイト配列をバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込まれるバイト配列
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeBytes- void writeBytes(byte[] value, int offset, int length) throws JMSExceptionバイト配列の一部をバイトメッセージストリームに書き込みます。- パラメーター:
- value- 書き込まれるバイト配列値
- offset- バイト配列内の初期オフセット
- length- 使用するバイト数
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
 
 - writeObject- void writeObject(ObjectSE value) throws JMSException オブジェクトをバイトメッセージストリームに書き込みます。- このメソッドは、オブジェクト化されたプリミティブオブジェクト型( - Integer、- Double、- Long...)、- Stringオブジェクト、バイト配列に対してのみ機能します。- パラメーター:
- value- 書き込まれる Java プログラミング言語のオブジェクト(「Java オブジェクト」)。null であってはなりません
- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。
- MessageFormatException- オブジェクトの型が無効な場合。
- MessageNotWriteableException- メッセージが読み取り専用モードの場合。
- NullPointerExceptionSE- パラメーター- valueが null の場合。
 
 - reset- void reset() throws JMSExceptionメッセージ本文を読み取り専用モードにして、バイトストリームを先頭に再配置します。- 例外:
- JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージのリセットに失敗した場合。
- MessageFormatException- メッセージの形式が無効な場合。