7.4.13 TextMessageインタフェース
TextMessageインタフェースはjava.lang.String型のデータを含むメッセージを送受信するために使用します。TextMessageインタフェースはMessageインタフェースを継承しているため，Messageインタフェースの機能を持っています。
- 〈この項の構成〉
(1) ペイロードの設定と取得
TextMessageインタフェースを使用することでペイロードを設定および取得できます。このペイロードはjava.lang.String型のデータです。JMSメッセージの各要素については，「2.5.1 JMSメッセージの構成」を参照してください。
(2) 形式
public interface TextMessage extends Message
{
public java.lang.String
getText() throws JMSException;
public void setText(java.lang.String string) throws JMSException;
}
(3) フィールド
ありません。
(4) メソッド
「(2) 形式」に記載した順序で各メソッドを説明します。
(a) getTextメソッド
public java.lang.String getText() throws JMSException
メッセージのデータを含む文字列を返します。メッセージ本体が設定されていない場合はデフォルト値であるnullを返します。
-
引数
ありません。
-
戻り値
メッセージのデータを含むStringオブジェクト。
-
例外
例外クラス
説明
JMSException
内部エラーのためにJMSプロバイダがテキストの取得に失敗しました。
例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9 障害コードの詳細」を参照してください。
(b) setTextメソッド
public void setText(java.lang.String string) throws JMSException
メッセージのデータを含む文字列を設定します。
-
引数
引数名
説明
string
メッセージのデータを含むStringオブジェクト
-
戻り値
ありません。
-
例外
例外クラス
説明
JMSException
string引数にnullが指定されました。
内部エラーのためにJMSプロバイダがテキストの設定に失敗しました。
MessageNotWriteableException
読み取り専用モードのペイロードに情報を書き込もうとしました。
例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9 障害コードの詳細」を参照してください。