Interface TypeDecoder<V>

    • Method Detail

      • getTypeClass

        java.lang.Class<V> getTypeClass()
        Returns:
        the Class that this decoder handles.
      • isArrayType

        boolean isArrayType()
        Returns:
        true if the underlying type that is going to be decoded is an array type
      • readValue

        V readValue​(ProtonBuffer buffer,
                    DecoderState state)
             throws DecodeException
        Reads the next type from the given buffer and returns it.
        Parameters:
        buffer - the source of encoded data.
        state - the current state of the decoder.
        Returns:
        the next instance in the stream that this decoder handles.
        Throws:
        DecodeException - if an error is encountered while reading the next value.
      • skipValue

        void skipValue​(ProtonBuffer buffer,
                       DecoderState state)
                throws DecodeException
        Skips over the bytes that compose the type this descriptor decodes.

        Skipping values can be used when the type is not used or processed by the application doing the decoding. An example might be an AMQP message decoder that only needs to decode certain parts of the message and not others.

        Parameters:
        buffer - The buffer that contains the encoded type.
        state - The decoder state.
        Throws:
        DecodeException - if an error occurs while skipping the value.
      • readArrayElements

        V[] readArrayElements​(ProtonBuffer buffer,
                              DecoderState state,
                              int count)
                       throws DecodeException
        Reads a series of this type that have been encoded into the body of an Array type.

        When encoded into an array the values are encoded in series following the identifier for the type, this method is given a count of the number of instances that are encoded and should read each in succession and returning them in a new array.

        Parameters:
        buffer - the source of encoded data.
        state - the current state of the decoder.
        count - the number of array elements encoded in the buffer.
        Returns:
        the next instance in the stream that this decoder handles.
        Throws:
        DecodeException - if an error is encountered while reading the next value.