org.seasar.jms.core.message.impl
クラス TextMessageFactory

java.lang.Object
  上位を拡張 org.seasar.jms.core.message.impl.AbstractMessageFactory<TextMessage>
      上位を拡張 org.seasar.jms.core.message.impl.TextMessageFactory
すべての実装されたインタフェース:
MessageFactory<TextMessage>

public class TextMessageFactory
extends AbstractMessageFactory<TextMessage>

TextMessageを作成するコンポーネントです。

このクラスはインスタンスモードPROTOTYPEで使われることを想定しており、スレッドセーフではありません。

作成者:
koichik

フィールドの概要
protected  TextProvider textProvider
          受信したJMSメッセージのペイロード
 
クラス org.seasar.jms.core.message.impl.AbstractMessageFactory から継承されたフィールド
correlationID, correlationIDAsBytes, properties, replyTo
 
コンストラクタの概要
TextMessageFactory()
          インスタンスを構築します。
TextMessageFactory(String text)
          インスタンスを構築します。
TextMessageFactory(TextProvider textProvider)
          インスタンスを構築します。
 
メソッドの概要
protected  TextMessage createMessageInstance(Session session)
          JMSセッションからTextMessageを作成して返します。
 String getText()
          JMSメッセージのペイロードに設定される文字列を返します。
 TextProvider getTextProvider()
          JMSメッセージのペイロードに設定される文字列を提供するプロバイダを返します。
 void setText(String text)
          JMSメッセージのペイロードに設定される文字列を設定します。
 void setTextProvider(TextProvider textProvider)
          JMSメッセージのペイロードに設定される文字列を提供するプロバイダを設定します。
protected  void setupPayload(TextMessage message)
          JMSペイロードにtextプロパティの値を設定します。
 
クラス org.seasar.jms.core.message.impl.AbstractMessageFactory から継承されたメソッド
addProperties, addProperty, createMessage, setCorrelationID, setCorrelationIDAsBytes, setReplyTo, setupHeader, setupProperties
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

textProvider

protected TextProvider textProvider
受信したJMSメッセージのペイロード

コンストラクタの詳細

TextMessageFactory

public TextMessageFactory()
インスタンスを構築します。

このコンストラクタでインスタンスを構築した場合、textプロパティまたは textProviderプロパティの設定は必須となります。


TextMessageFactory

public TextMessageFactory(String text)
インスタンスを構築します。

パラメータ:
text - JMSメッセージのペイロードに設定される文字列

TextMessageFactory

public TextMessageFactory(TextProvider textProvider)
インスタンスを構築します。

パラメータ:
textProvider - JMSメッセージのペイロードに設定される文字列を提供するプロバイダ
メソッドの詳細

getText

public String getText()
JMSメッセージのペイロードに設定される文字列を返します。

戻り値:
JMSメッセージのペイロードに設定される文字列

setText

public void setText(String text)
JMSメッセージのペイロードに設定される文字列を設定します。

デフォルトコンストラクタでインスタンスを構築した場合、このプロパティまたは textProviderプロパティの設定は必須です。

パラメータ:
text - JMSメッセージのペイロードに設定される文字列

getTextProvider

public TextProvider getTextProvider()
JMSメッセージのペイロードに設定される文字列を提供するプロバイダを返します。

戻り値:
JMSメッセージのペイロードに設定される文字列を提供するプロバイダ

setTextProvider

public void setTextProvider(TextProvider textProvider)
JMSメッセージのペイロードに設定される文字列を提供するプロバイダを設定します。

デフォルトコンストラクタでインスタンスを構築した場合、このプロパティまたは textプロパティの設定は必須です。

パラメータ:
textProvider - JMSメッセージのペイロードに設定される文字列を提供するプロバイダ

createMessageInstance

protected TextMessage createMessageInstance(Session session)
                                     throws JMSException
JMSセッションからTextMessageを作成して返します。

定義:
クラス AbstractMessageFactory<TextMessage> 内の createMessageInstance
パラメータ:
session - JMSセッション
戻り値:
JMSセッションから作成されたTextMessage
例外:
JMSException - JMSメッセージを作成できなかった場合にスローされます。

setupPayload

protected void setupPayload(TextMessage message)
                     throws JMSException
JMSペイロードにtextプロパティの値を設定します。

定義:
クラス AbstractMessageFactory<TextMessage> 内の setupPayload
パラメータ:
message - JMSメッセージ
例外:
JMSException - JMSメッセージにペイロードを設定できなかった場合にスローされます


Copyright © 2005-2009 The Seasar Foundation. All Rights Reserved.