org.ikasan.framework.payload.serialisation
Class TextMessagePayloadSerialiser

java.lang.Object
  org.ikasan.framework.payload.serialisation.TextMessagePayloadSerialiser

All Implemented Interfaces:

JmsMessagePayloadSerialiser<javax.jms.TextMessage>

public class TextMessagePayloadSerialiser
extends Object
implements JmsMessagePayloadSerialiser<javax.jms.TextMessage>

Default TextMessage implementation of JmsMessagePayloadSerialiser

Author:

Ikasan Development Team

Constructor Summary

TextMessagePayloadSerialiser()

Method Summary

Class<? extends javax.jms.Message>	getSupportedMessageType() Get the supported message type
void	setPayloadFactory(PayloadFactory payloadFactory) Allows the payload factory to be set, only necessary if we are deserialising
boolean	supports(Class<? extends javax.jms.Message> messageClass) Indicates if a particular Message implementation is supported
javax.jms.TextMessage	toMessage(Payload payload, javax.jms.Session session) Converts a Payload to a Message
Payload	toPayload(javax.jms.TextMessage message) Converts a Message to a Payload

Methods inherited from class java.lang.Object

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

Constructor Detail

TextMessagePayloadSerialiser

public TextMessagePayloadSerialiser()

Method Detail

getSupportedMessageType

public Class<? extends javax.jms.Message> getSupportedMessageType()

Description copied from interface: JmsMessagePayloadSerialiser

Get the supported message type

Specified by:

getSupportedMessageType in interface JmsMessagePayloadSerialiser<javax.jms.TextMessage>

Returns:

the supported message type

See Also:

JmsMessagePayloadSerialiser.getSupportedMessageType()

supports

public boolean supports(Class<? extends javax.jms.Message> messageClass)

Description copied from interface: JmsMessagePayloadSerialiser

Indicates if a particular Message implementation is supported

Specified by:

supports in interface JmsMessagePayloadSerialiser<javax.jms.TextMessage>

Parameters:

messageClass - - A class that extends Message

Returns:

true if the given message class is supported

toMessage

public javax.jms.TextMessage toMessage(Payload payload,
                                       javax.jms.Session session)
                                throws javax.jms.JMSException

Description copied from interface: JmsMessagePayloadSerialiser

Converts a Payload to a Message

Specified by:

toMessage in interface JmsMessagePayloadSerialiser<javax.jms.TextMessage>

Parameters:

payload - - Payload to convert into a Message

session - - JMS Session we're in

Returns:

a Message

Throws:

javax.jms.JMSException - - JMS related exception

toPayload

public Payload toPayload(javax.jms.TextMessage message)
                  throws javax.jms.JMSException

Description copied from interface: JmsMessagePayloadSerialiser

Converts a Message to a Payload

Specified by:

toPayload in interface JmsMessagePayloadSerialiser<javax.jms.TextMessage>

Parameters:

message - - Message to convert into a Payload

Returns:

a Payload

Throws:

javax.jms.JMSException - - JMS related exception

setPayloadFactory

public void setPayloadFactory(PayloadFactory payloadFactory)

Allows the payload factory to be set, only necessary if we are deserialising

Parameters:

payloadFactory - - The PayloadFactory for deserialising