Package org.apache.qpid.protonj2.codec.decoders

Class UnknownDescribedTypeDecoder

java.lang.Object
org.apache.qpid.protonj2.codec.decoders.AbstractDescribedTypeDecoder<DescribedType>
org.apache.qpid.protonj2.codec.decoders.UnknownDescribedTypeDecoder
All Implemented Interfaces:
DescribedTypeDecoder<DescribedType>, StreamDescribedTypeDecoder<DescribedType>, StreamTypeDecoder<DescribedType>, TypeDecoder<DescribedType>
public abstract class UnknownDescribedTypeDecoder extends AbstractDescribedTypeDecoder<DescribedType>
Decoder of AMQP Described type values from a byte stream.

  • Constructor Details

    • UnknownDescribedTypeDecoder

      public UnknownDescribedTypeDecoder()

  • Method Details

    • getDescriptor

      public abstract Object getDescriptor()
      Returns:
      the AMQP type descriptor for this TypeDecoder.

    • getDescriptorCode

      public final UnsignedLong getDescriptorCode()
      Description copied from interface: DescribedTypeDecoder
      Returns the AMQP descriptor code for the type this decoder reads.
      Returns:
      an unsigned long descriptor code value.

    • getDescriptorSymbol

      public final Symbol getDescriptorSymbol()
      Description copied from interface: DescribedTypeDecoder
      Returns the AMQP descriptor symbol for the type this decoder reads.
      Returns:
      an symbol descriptor code value.

    • getTypeClass

      public final Class<DescribedType> getTypeClass()
      Returns:
      the Class that this decoder handles.

    • readValue

      public final DescribedType readValue(ProtonBuffer buffer, DecoderState state) throws DecodeException
      Description copied from interface: TypeDecoder
      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.

    • readValue

      public final DescribedType readValue(InputStream stream, StreamDecoderState state) throws DecodeException
      Description copied from interface: StreamTypeDecoder
      Reads the next type from the given buffer and returns it.
      Parameters:
      stream - 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.

    • readArrayElements

      public final DescribedType[] readArrayElements(ProtonBuffer buffer, DecoderState state, int count) throws DecodeException
      Description copied from interface: TypeDecoder
      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.

    • readArrayElements

      public final DescribedType[] readArrayElements(InputStream stream, StreamDecoderState state, int count) throws DecodeException
      Description copied from interface: StreamTypeDecoder
      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:
      stream - 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.

    • skipValue

      public final void skipValue(ProtonBuffer buffer, DecoderState state) throws DecodeException
      Description copied from interface: TypeDecoder
      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.

    • skipValue

      public final void skipValue(InputStream stream, StreamDecoderState state) throws DecodeException
      Description copied from interface: StreamTypeDecoder
      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:
      stream - The stream that contains the encoded type.
      state - The decoder state.
      Throws:
      DecodeException - if an error occurs while skipping the value.