インターフェース MapMessage
- すべてのスーパーインターフェース:
Message
public interface MapMessage extends Message
MapMessageオブジェクトは、名前と値のペアのセットを送信するために使用されます。名前はStringオブジェクトであり、値は Java プログラミング言語のプリミティブデータ型です。名前には、null ではなく、空の文字列ではない値を含める必要があります。エントリには、名前で順次またはランダムにアクセスできます。エントリの順序は定義されていません。MapMessageはMessageインターフェースを継承し、マップを含むメッセージ本文を追加します。プリミティブ型は、各型のメソッドを使用して明示的に読み書きできます。また、オブジェクトとして一般的に読み書きすることもできます。たとえば、
MapMessage.setInt("foo", 6)の呼び出しはMapMessage.setObject("foo", new Integer(6))と同等です。明示的なフォームは静的プログラミングに便利であり、コンパイル時に型が不明な場合はオブジェクトフォームが必要であるため、両方のフォームが提供されます。クライアントが
MapMessageを受信すると、読み取り専用モードになります。この時点でクライアントがメッセージに書き込もうとすると、MessageNotWriteableExceptionがスローされます。clearBodyが呼び出されると、メッセージの読み取りと書き込みの両方が可能になります。MapMessageオブジェクトは、次の変換テーブルをサポートしています。マークされたケースはサポートされている必要があります。マークされていないケースはJMSExceptionをスローする必要があります。プリミティブのvalueOf()メソッドがプリミティブの有効なString表現として受け入れない場合、String-to-primitive 変換はランタイム例外をスローする可能性があります。行型として書き込まれた値は、列型として読み取ることができます。
| | boolean byte short char int long float double String byte[] |---------------------------------------------------------------------- |boolean | X X |byte | X X X X X |short | X X X X |char | X X |int | X X X |long | X X |float | X X X |double | X X |String | X X X X X X X X |byte[] | X |----------------------------------------------------------------------
null 値をプリミティブ型として読み取ろうとすると、null 値を指定して、プリミティブの対応する
valueOf(String)変換メソッドを呼び出すことになります。charはString変換をサポートしていないため、charとして null 値を読み取ろうとすると、NullPointerExceptionがスローされます。- 導入:
- JMS 1.0
- バージョン:
- Jakarta Messaging 2.0
- 関連事項:
Session.createMapMessage(),BytesMessage,Message,ObjectMessage,StreamMessage,TextMessage
フィールド概要
インターフェース jakarta.jms.Message から継承されたフィールド
DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 booleangetBoolean(StringSE name)指定された名前のboolean値を返します。bytegetByte(StringSE name)指定された名前のbyte値を返します。byte[]getBytes(StringSE name)指定された名前のバイト配列値を返します。chargetChar(StringSE name)指定された名前の Unicode 文字値を返します。doublegetDouble(StringSE name)指定された名前のdouble値を返します。floatgetFloat(StringSE name)指定された名前のfloat値を返します。intgetInt(StringSE name)指定された名前のint値を返します。longgetLong(StringSE name)指定された名前のlong値を返します。EnumerationSEgetMapNames()MapMessageオブジェクト内のすべての名前のEnumerationを返します。ObjectSEgetObject(StringSE name)指定された名前のオブジェクトの値を返します。shortgetShort(StringSE name)指定された名前のshort値を返します。StringSEgetString(StringSE name)指定された名前のString値を返します。booleanitemExists(StringSE name)このMapMessageオブジェクトにアイテムが存在するかどうかを示します。voidsetBoolean(StringSE name, boolean value)指定された名前のboolean値をマップに設定します。voidsetByte(StringSE name, byte value)指定された名前のbyte値をマップに設定します。voidsetBytes(StringSE name, byte[] value)指定された名前のバイト配列値をマップに設定します。voidsetBytes(StringSE name, byte[] value, int offset, int length)指定された名前のバイト配列値の一部をマップに設定します。voidsetChar(StringSE name, char value)指定された名前の Unicode 文字値をマップに設定します。voidsetDouble(StringSE name, double value)指定された名前のdouble値をマップに設定します。voidsetFloat(StringSE name, float value)指定された名前のfloat値をマップに設定します。voidsetInt(StringSE name, int value)指定された名前のint値をマップに設定します。voidsetLong(StringSE name, long value)指定された名前のlong値をマップに設定します。voidsetObject(StringSE name, ObjectSE value)指定された名前のオブジェクト値をマップに設定します。voidsetShort(StringSE name, short value)指定された名前のshort値をマップに設定します。voidsetString(StringSE name, StringSE value)指定された名前のString値をマップに設定します。インターフェース 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
メソッドの詳細
getBoolean
boolean getBoolean(StringSE name) throws JMSException
指定された名前のboolean値を返します。- パラメーター:
name-booleanの名前- 戻り値:
- 指定された名前の
boolean値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getByte
byte getByte(StringSE name) throws JMSException
指定された名前のbyte値を返します。- パラメーター:
name-byteの名前- 戻り値:
- 指定された名前の
byte値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getShort
short getShort(StringSE name) throws JMSException
指定された名前のshort値を返します。- パラメーター:
name-shortの名前- 戻り値:
- 指定された名前の
short値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getChar
char getChar(StringSE name) throws JMSException
指定された名前の Unicode 文字値を返します。- パラメーター:
name- Unicode 文字の名前- 戻り値:
- 指定された名前の Unicode 文字値
- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getInt
int getInt(StringSE name) throws JMSException
指定された名前のint値を返します。- パラメーター:
name-intの名前- 戻り値:
- 指定された名前の
int値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getLong
long getLong(StringSE name) throws JMSException
指定された名前のlong値を返します。- パラメーター:
name-longの名前- 戻り値:
- 指定された名前の
long値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getFloat
float getFloat(StringSE name) throws JMSException
指定された名前のfloat値を返します。- パラメーター:
name-floatの名前- 戻り値:
- 指定された名前の
float値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getDouble
double getDouble(StringSE name) throws JMSException
指定された名前のdouble値を返します。- パラメーター:
name-doubleの名前- 戻り値:
- 指定された名前の
double値 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getString
StringSE getString(StringSE name) throws JMSException
指定された名前のString値を返します。- パラメーター:
name-Stringの名前- 戻り値:
- 指定された名前の
String値。この名前のアイテムがない場合は、null 値が返されます - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getBytes
byte[] getBytes(StringSE name) throws JMSException
指定された名前のバイト配列値を返します。- パラメーター:
name- バイト配列の名前- 戻り値:
- 指定された名前のバイト配列値のコピー。この名前のアイテムがない場合は、null 値が返されます。
- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。MessageFormatException- この型変換が無効な場合。
getObject
ObjectSE getObject(StringSE name) throws JMSException
指定された名前のオブジェクトの値を返します。このメソッドを使用して、同等の
setObjectメソッド呼び出しまたは同等のプリミティブsettypeメソッドで Map に格納されていた Java プログラミング言語のオブジェクト(「Java オブジェクト」)をオブジェクト化された形式で返すことができます。バイト値は
Byte[]ではなくbyte[]として返されることに注意してください。- パラメーター:
name- Java オブジェクトの名前- 戻り値:
- オブジェクト化された形式での、指定された名前の Java オブジェクト値のコピー(たとえば、オブジェクトが
intとして設定された場合、Integerが返されます); この名前のアイテムがない場合は、null 値が返されます - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
getMapNames
EnumerationSE getMapNames() throws JMSException
MapMessageオブジェクト内のすべての名前のEnumerationを返します。- 戻り値:
- この
MapMessageのすべての名前の列挙 - 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの読み取りに失敗した場合。
setBoolean
void setBoolean(StringSE name, boolean value) throws JMSException
指定された名前のboolean値をマップに設定します。- パラメーター:
name-booleanの名前value- マップに設定するboolean値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setByte
void setByte(StringSE name, byte value) throws JMSException
指定された名前のbyte値をマップに設定します。- パラメーター:
name-byteの名前value- マップに設定するbyte値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setShort
void setShort(StringSE name, short value) throws JMSException
指定された名前のshort値をマップに設定します。- パラメーター:
name-shortの名前value- マップに設定するshort値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setChar
void setChar(StringSE name, char value) throws JMSException
指定された名前の Unicode 文字値をマップに設定します。- パラメーター:
name- Unicode 文字の名前value- マップに設定する Unicode 文字値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setInt
void setInt(StringSE name, int value) throws JMSException
指定された名前のint値をマップに設定します。- パラメーター:
name-intの名前value- マップに設定するint値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setLong
void setLong(StringSE name, long value) throws JMSException
指定された名前のlong値をマップに設定します。- パラメーター:
name-longの名前value- マップに設定するlong値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setFloat
void setFloat(StringSE name, float value) throws JMSException
指定された名前のfloat値をマップに設定します。- パラメーター:
name-floatの名前value- マップに設定するfloat値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setDouble
void setDouble(StringSE name, double value) throws JMSException
指定された名前のdouble値をマップに設定します。- パラメーター:
name-doubleの名前value- マップに設定するdouble値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setString
void setString(StringSE name, StringSE value) throws JMSException
指定された名前のString値をマップに設定します。- パラメーター:
name-Stringの名前value- マップに設定するString値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setBytes
void setBytes(StringSE name, byte[] value) throws JMSException
指定された名前のバイト配列値をマップに設定します。- パラメーター:
name- バイト配列の名前value- マップに設定するバイト配列値。nameの値が将来の変更によって変更されないように配列がコピーされます- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setBytes
void setBytes(StringSE name, byte[] value, int offset, int length) throws JMSException
指定された名前のバイト配列値の一部をマップに設定します。- パラメーター:
name- バイト配列の名前value- マップに設定するバイト配列値offset- バイト配列内の初期オフセットlength- 使用するバイト数- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
setObject
void setObject(StringSE name, ObjectSE value) throws JMSException
指定された名前のオブジェクト値をマップに設定します。このメソッドは、オブジェクト化されたプリミティブオブジェクト型(
Integer、Double、Long...)、Stringオブジェクト、バイト配列に対してのみ機能します。- パラメーター:
name- Java オブジェクトの名前value- マップに設定する Java オブジェクトの値- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの書き込みに失敗した場合。IllegalArgumentExceptionSE- 名前が null の場合、または名前が空の文字列の場合。MessageFormatException- オブジェクトが無効な場合。MessageNotWriteableException- メッセージが読み取り専用モードの場合。
itemExists
boolean itemExists(StringSE name) throws JMSException
このMapMessageオブジェクトにアイテムが存在するかどうかを示します。- パラメーター:
name- テストするアイテムの名前- 戻り値:
- アイテムが存在する場合は true
- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがアイテムの存在を確認できない場合