org.exolab.jmscts.core
Class AbstractMessagePopulator

java.lang.Object
  |
  +--org.exolab.jmscts.core.AbstractMessagePopulator

All Implemented Interfaces:

MessagePopulator, java.io.Serializable

Direct Known Subclasses:

BasicMessagePopulator, MessageContentPopulator, MessageSizePopulator, SequenceMessagePopulator

public abstract class AbstractMessagePopulator

extends java.lang.Object

implements MessagePopulator

A helper class for populating messages. This class provides no message populating functionality - that is left to sublasses.

Version:

$Revision: 1.3 $ $Date: 2004/01/31 13:44:24 $

Author:

Tim Anderson

See Also:

Serialized Form

Constructor Summary

AbstractMessagePopulator()

Method Summary

void	populate(javax.jms.Message message) Populate a message with data.
void	populateBytesMessage(javax.jms.BytesMessage message) Populate a BytesMessage instance with data.
void	populateMapMessage(javax.jms.MapMessage message) Populate a MapMessage instance with data.
void	populateMessage(javax.jms.Message message) Populate a Message instance with data.
void	populateObjectMessage(javax.jms.ObjectMessage message) Populate an ObjectMessage instance with data.
void	populateStreamMessage(javax.jms.StreamMessage message) Populate a StreamMessage instance with data.
void	populateTextMessage(javax.jms.TextMessage message) Populate a TextMessage instance with data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMessagePopulator

public AbstractMessagePopulator()

Method Detail

populate

public void populate(javax.jms.Message message)
              throws java.lang.Exception

Populate a message with data. This method delegates the message to the appropriate populator method.

Specified by:

populate in interface MessagePopulator

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error

populateMessage

public void populateMessage(javax.jms.Message message)
                     throws java.lang.Exception

Populate a Message instance with data. This method throws UnsupportedOperationException if invoked. Subclasses needing the functionality must implement it.

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error

populateBytesMessage

public void populateBytesMessage(javax.jms.BytesMessage message)
                          throws java.lang.Exception

Populate a BytesMessage instance with data. This method throws UnsupportedOperationException if invoked. Subclasses needing the functionality must implement it.

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error

populateMapMessage

public void populateMapMessage(javax.jms.MapMessage message)
                        throws java.lang.Exception

Populate a MapMessage instance with data. This method throws UnsupportedOperationException if invoked. Subclasses needing the functionality must implement it.

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error

populateObjectMessage

public void populateObjectMessage(javax.jms.ObjectMessage message)
                           throws java.lang.Exception

Populate an ObjectMessage instance with data. This method throws UnsupportedOperationException if invoked. Subclasses needing the functionality must implement it.

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error

populateStreamMessage

public void populateStreamMessage(javax.jms.StreamMessage message)
                           throws java.lang.Exception

Populate a StreamMessage instance with data. This method throws UnsupportedOperationException if invoked. Subclasses needing the functionality must implement it.

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error

populateTextMessage

public void populateTextMessage(javax.jms.TextMessage message)
                         throws java.lang.Exception

Populate a TextMessage instance with data. This method throws UnsupportedOperationException if invoked. Subclasses needing the functionality must implement it.

Parameters:

message - the message to populate

Throws:

java.lang.Exception - for any error