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

Class UnsignedLong0TypeDecoder

java.lang.Object
org.apache.qpid.protonj2.codec.decoders.AbstractPrimitiveTypeDecoder<UnsignedLong>
org.apache.qpid.protonj2.codec.decoders.primitives.UnsignedLong0TypeDecoder
All Implemented Interfaces:
PrimitiveTypeDecoder<UnsignedLong>, StreamTypeDecoder<UnsignedLong>, TypeDecoder<UnsignedLong>
public final class UnsignedLong0TypeDecoder extends AbstractPrimitiveTypeDecoder<UnsignedLong>
Decode AMQP Zero value Unsigned Long values from a byte stream

  • Field Details

  • Constructor Details

    • UnsignedLong0TypeDecoder

      public UnsignedLong0TypeDecoder()

  • Method Details

    • getTypeCode

      public int getTypeCode()
      Description copied from interface: PrimitiveTypeDecoder
      Returns the AMQP Encoding Code that this primitive type decoder can read.
      Returns:
      the AMQP Encoding Code that this primitive type decoder can read

    • isZeroWidth

      public boolean isZeroWidth()
      Description copied from interface: PrimitiveTypeDecoder
      Returns true if the underlying type is a zero width type that has no encoding beyond the encoding code.
      Returns:
      true if the underlying type is a zero width type that has no encoding beyond the encoding code

    • getTypeClass

      public Class<UnsignedLong> getTypeClass()
      Description copied from interface: TypeDecoder
      Returns the Class that this decoder handles.
      Returns:
      the Class that this decoder handles

    • readValue

      public UnsignedLong 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 UnsignedLong 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.

    • skipValue

      public 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 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.

    • readSize

      public int readSize(ProtonBuffer buffer, DecoderState state)
      Description copied from interface: TypeDecoder
      Reads the size in bytes of the encoded AMQP type from the given buffer and returns it. Since this methods advances the read position of the provided buffer the caller must either reset that based on a previous mark or they must read the primitive payload manually as the decoder would not be able to read the value as it has no retained state.
      Parameters:
      buffer - the source of encoded data.
      state - the current state of the decoder.
      Returns:
      the size in bytes of the encoded primitive value.

    • readSize

      public int readSize(InputStream stream, StreamDecoderState state)
      Description copied from interface: StreamTypeDecoder
      Reads the size in bytes of the encoded primitive from the given InputStream and returns it. Since this methods advances the read position of the provided stream the caller must either reset that based on a previous mark or they must read the primitive payload manually as the decoder would not be able to read the value as it has no retained state.
      Parameters:
      stream - the source of encoded data.
      state - the current state of the decoder.
      Returns:
      the size in bytes of the encoded primitive value.