Module com.aoapps.messaging.api

Package com.aoapps.messaging

Class StringMessage

java.lang.Object

com.aoapps.messaging.StringMessage

All Implemented Interfaces:

Message, Closeable, AutoCloseable

public class StringMessage
extends Object
implements Message

A message that is a String.

Field Summary

Fields

Modifier and Type	Field	Description
static final StringMessage	EMPTY_STRING_MESSAGE

Constructor Summary

Constructors

Constructor	Description
StringMessage(String message)	Creates a new StringMessage.

Method Summary

Modifier and Type	Method	Description
void	close()	The message should be closed when it is no longer needed.
static StringMessage	decode(ByteArray encodedMessage)	StandardCharsets.UTF_8 decodes the message.
ByteArray	encodeAsByteArray()	StandardCharsets.UTF_8 encodes the message.
String	encodeAsString()	Gets a String representation of this message.
boolean	equals(Object o)	Two messages of the same type with the same body must be considered equal.
String	getMessage()
MessageType	getMessageType()	Gets the message type.
int	hashCode()	The hash code must be consistent with equals.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_STRING_MESSAGE

public static final StringMessage EMPTY_STRING_MESSAGE

Constructor Details

StringMessage

public StringMessage(String message)

Creates a new StringMessage.

Method Details

decode

public static StringMessage decode(ByteArray encodedMessage)

StandardCharsets.UTF_8 decodes the message.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from interface: Message

Two messages of the same type with the same body must be considered equal.

Specified by:

equals in interface Message

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: Message

The hash code must be consistent with equals.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class Object

getMessageType

public MessageType getMessageType()

Description copied from interface: Message

Gets the message type.

Specified by:

getMessageType in interface Message

encodeAsString

public String encodeAsString()

Description copied from interface: Message

Gets a String representation of this message.

Specified by:

encodeAsString in interface Message

encodeAsByteArray

public ByteArray encodeAsByteArray()

StandardCharsets.UTF_8 encodes the message.

Specified by:

encodeAsByteArray in interface Message

close

public void close()

Description copied from interface: Message

The message should be closed when it is no longer needed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Message

getMessage

public String getMessage()