asia.stampy.common.message

Class AbstractMessage<HDR extends StampyMessageHeader>

java.lang.Object

asia.stampy.common.message.AbstractMessage<HDR>

Type Parameters:

HDR - the generic type

All Implemented Interfaces:

StampyMessage<HDR>, java.io.Serializable

Direct Known Subclasses:

AbortMessage, AbstractBodyMessage, AckMessage, BeginMessage, CommitMessage, ConnectedMessage, ConnectMessage, DisconnectMessage, NackMessage, ReceiptMessage, StompMessage, SubscribeMessage, UnsubscribeMessage

@StampyLibrary(libraryName="stampy-core")
public abstract class AbstractMessage<HDR extends StampyMessageHeader>
extends java.lang.Object
implements StampyMessage<HDR>

Abstract implementation of a StampyMessage.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessage(StompMessageType messageType) Instantiates a new abstract message.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract HDR	createNewHeader() Creates the new header.
boolean	equals(java.lang.Object o)
HDR	getHeader() Gets the header.
StompMessageType	getMessageType() Gets the message type.
int	hashCode()
protected java.lang.String	postHeader() This method is used to create the body of the message, if applicable.
java.lang.String	toStompMessage(boolean validate) Returns a STOMP-string representation of a StampyMessage.
java.lang.String	toString()
abstract void	validate() Validates the message should AbstractMessage#toStompMessage(true) be called.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractMessage

protected AbstractMessage(StompMessageType messageType)

Instantiates a new abstract message.

Parameters:

messageType - the message type

Method Detail

getHeader

public HDR getHeader()

Description copied from interface: StampyMessage

Gets the header.

Specified by:

getHeader in interface StampyMessage<HDR extends StampyMessageHeader>

Returns:

the header

createNewHeader

protected abstract HDR createNewHeader()

Creates the new header.

Returns:

the hdr

getMessageType

public StompMessageType getMessageType()

Description copied from interface: StampyMessage

Gets the message type.

Specified by:

getMessageType in interface StampyMessage<HDR extends StampyMessageHeader>

Returns:

the message type

toStompMessage

public final java.lang.String toStompMessage(boolean validate)

Description copied from interface: StampyMessage

Returns a STOMP-string representation of a StampyMessage.

Specified by:

toStompMessage in interface StampyMessage<HDR extends StampyMessageHeader>

Parameters:

validate - if true message validation is executed

Returns:

the string

validate

public abstract void validate()

Validates the message should AbstractMessage#toStompMessage(true) be called.

Specified by:

validate in interface StampyMessage<HDR extends StampyMessageHeader>

postHeader

protected java.lang.String postHeader()

This method is used to create the body of the message, if applicable. The default implementation returns null.

Returns:

the string

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object