Package org.symbol.sdk.nem.models

Class Message

java.lang.Object

org.symbol.sdk.CatbufferType

org.symbol.sdk.nem.models.Message

All Implemented Interfaces:

Serializer

---

public final class Message extends CatbufferType

• Field Summary

  Fields

  Modifier and Type

  Field

  Description

  static final Map<String,String>

  TYPE_HINTS

   

• Constructor Summary

  Constructors

  Constructor

  Description

  Message()

  Creates a new Message.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  static Message

  deserialize(ByteBuffer buffer)

  Deserializes an instance of this object from a byte payload.

  Object

  getField(String name)

  Reads a named field.

  byte[]

  getMessage()

  Gets the message field.

  MessageType

  getMessageType()

  Gets the messageType field.

  protected void

  serializeInto(Writer buffer)

  Writes this object's fields into the supplied buffer.

  void

  setField(String name, Object value)

  Sets a named field.

  void

  setMessage(byte[] value)

  Sets the message field.

  void

  setMessageType(MessageType value)

  Sets the messageType field.

  int

  size()

  Calculates the size of the object.

  Map<String,Object>

  toJson()

  Converts this object to a JSON-serializable representation.

  String

  toString()

  Returns a string representation of this object.

  Map<String,String>

  typeHints()

  Returns the type-hint map driving the rule-based descriptor pipeline.

  Methods inherited from class org.symbol.sdk.CatbufferType

  asByteArray, asBytes, asInt, asList, asLong, serialize, sort, toJsonString

  Methods inherited from class java.lang.Object

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

• Field Details

  • TYPE_HINTS

    public static final Map<String,String> TYPE_HINTS

• Constructor Details

  • Message

    public Message()

    Creates a new Message.

• Method Details

  • typeHints

    public Map<String,String> typeHints()

    Message.typeHints

    Returns the type-hint map driving the rule-based descriptor pipeline.

    Overrides:

    typeHints in class CatbufferType

    Returns:

    Field-name → rule-key map.

  • setField

    public void setField(String name, Object value)

    Message.setField

    Sets a named field. Used by the rule-based descriptor pipeline.

    Overrides:

    setField in class CatbufferType

    Parameters:

    name - Field name (descriptor key).

    value - Value to assign.

  • getField

    public Object getField(String name)

    Message.getField

    Reads a named field. Used by the facade-level entity inspection helpers.

    Overrides:

    getField in class CatbufferType

    Parameters:

    name - Field name.

    Returns:

    Field value.

  • getMessageType

    public MessageType getMessageType()

    Message.getMessageType

    Gets the messageType field.

    Returns:

    The messageType field.

  • setMessageType

    public void setMessageType(MessageType value)

    Message.setMessageType

    Sets the messageType field.

    Parameters:

    value - New messageType value.

  • getMessage

    public byte[] getMessage()

    Message.getMessage

    Gets the message field.

    Returns:

    The message field.

  • setMessage

    public void setMessage(byte[] value)

    Message.setMessage

    Sets the message field.

    Parameters:

    value - New message value.

  • size

    public int size()

    Message.size

    Calculates the size of the object.

    Returns:

    Size of this object in bytes.

  • deserialize

    public static Message deserialize(ByteBuffer buffer)

    Message.deserialize

    Deserializes an instance of this object from a byte payload.

    Parameters:

    buffer - Output writer.

    Returns:

    Deserialized object.

    Throws:

    IndexOutOfBoundsException - if the buffer is truncated or a declared length overruns it

    IllegalArgumentException - if a field carries an invalid value (e.g. a reserved field or unknown discriminator)

  • serializeInto

    protected void serializeInto(Writer buffer)

    Message.serializeInto

    Writes this object's fields into the supplied buffer.

    Specified by:

    serializeInto in class CatbufferType

    Parameters:

    buffer - Output writer.

  • toString

    public String toString()

    Message.toString

    Returns a string representation of this object.

    Overrides:

    toString in class Object

    Returns:

    String representation of this object.

  • toJson

    public Map<String,Object> toJson()

    Message.toJson

    Converts this object to a JSON-serializable representation.

    Specified by:

    toJson in class CatbufferType

    Returns:

    JSON-serializable representation of this object.