io.nem.symbol.sdk.model.message

Class Message

java.lang.Object

io.nem.symbol.sdk.model.message.Message

Direct Known Subclasses:

PersistentHarvestingDelegationMessage, RawMessage, TypedMessage

public abstract class Message
extends java.lang.Object

An abstract message class that serves as the base class of all message types.

Constructor Summary

Constructors

Constructor and Description
Message(byte[] payload, MessageType type)

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<Message>	createFromHexPayload(java.lang.String payloadHex) This factory method knows how to create the right Message instance from the provided message payload.
static java.util.Optional<Message>	createFromPayload(byte[] payload) This factory method knows how to create the right Message instance from the provided message payload.
boolean	equals(java.lang.Object o)
byte[]	getPayload()
java.nio.ByteBuffer	getPayloadByteBuffer()
java.lang.String	getPayloadHex()
abstract java.lang.String	getText() Returns payload as text.
MessageType	getType()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(byte[] payload,
               MessageType type)

Method Detail

createFromPayload

public static java.util.Optional<Message> createFromPayload(byte[] payload)

This factory method knows how to create the right Message instance from the provided message payload.

Parameters:

payload - the raw payload as it comes from binary data.

Returns:

the Message.

createFromHexPayload

public static java.util.Optional<Message> createFromHexPayload(java.lang.String payloadHex)

This factory method knows how to create the right Message instance from the provided message payload.

Parameters:

payloadHex - the raw payload as it comes from REST data.

Returns:

the Message.

getPayload

public byte[] getPayload()

Returns:

the raw byte payload.

getType

public MessageType getType()

Returns:

the type of this message.

getText

public abstract java.lang.String getText()

Returns payload as text. Sub

Returns:

String

getPayloadByteBuffer

public java.nio.ByteBuffer getPayloadByteBuffer()

Returns:

the full payload including the message type as byte buffer

getPayloadHex

public java.lang.String getPayloadHex()

Returns:

the full payload including the message type as 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