Class AZGenericMapPayload

  • All Implemented Interfaces:
    AZMessage, Message

    public class AZGenericMapPayload
    extends java.lang.Object
    implements AZMessage
    This is a helper class for creating messages with a Map'd beencode-able payload.
    • Field Detail

      • version

        private final byte version
      • type_id

        private final java.lang.String type_id
      • msg_map

        private final java.util.Map msg_map
    • Constructor Detail

      • AZGenericMapPayload

        public AZGenericMapPayload​(java.lang.String message_type,
                                   java.util.Map message,
                                   byte version)
        Create a new AZ message with the given message type id, with the given bencode-able map payload.
        Parameters:
        message_type - of message
        message - payload (to be bencoded)
    • Method Detail

      • getID

        public java.lang.String getID()
        Description copied from interface: Message
        Get message id.
        Specified by:
        getID in interface Message
        Returns:
        id
      • getIDBytes

        public byte[] getIDBytes()
        Specified by:
        getIDBytes in interface Message
      • getFeatureID

        public java.lang.String getFeatureID()
        Description copied from interface: Message
        Get the main feature set name this message belongs to.
        Specified by:
        getFeatureID in interface Message
        Returns:
        feature id
      • getFeatureSubID

        public int getFeatureSubID()
        Description copied from interface: Message
        Get the static message sub-id for the feature.
        Specified by:
        getFeatureSubID in interface Message
        Returns:
        sub id
      • getType

        public int getType()
        Description copied from interface: Message
        Get message type.
        Specified by:
        getType in interface Message
        Returns:
        type
      • getVersion

        public byte getVersion()
        Specified by:
        getVersion in interface Message
      • getMapPayload

        public java.util.Map getMapPayload()
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Message
        Get textual description of this particular message.
        Specified by:
        getDescription in interface Message
        Returns:
        description
      • getData

        public DirectByteBuffer[] getData()
        Description copied from interface: Message
        Get message payload data.
        Specified by:
        getData in interface Message
        Returns:
        message data buffers
      • deserialize

        public Message deserialize​(DirectByteBuffer data,
                                   byte version)
                            throws MessageException
        Description copied from interface: Message
        Create a new instance of this message by decoding the given byte serialization.
        Specified by:
        deserialize in interface Message
        Parameters:
        data - to deserialize
        Returns:
        decoded message instance
        Throws:
        MessageException - if the decoding process fails NOTE: Does not auto-return given direct buffer on thrown exception.
      • destroy

        public void destroy()
        Description copied from interface: Message
        Destroy the message; i.e. perform cleanup actions.
        Specified by:
        destroy in interface Message