Package org.apache.qpid.protonj2.codec

Interface StreamDecoder

  • All Known Implementing Classes:
    ProtonStreamDecoder
    public interface StreamDecoder
    Decode AMQP types from a InputStream

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      StreamDecoderState getCachedDecoderState()
      Return a singleton StreamDecoderState instance that is meant to be shared within single threaded decoder interactions.
      StreamDecoderState newDecoderState()
      Creates a new StreamDecoderState instance that can be used when interacting with the Decoder.
      StreamTypeDecoder<?> peekNextTypeDecoder​(java.io.InputStream stream, StreamDecoderState state)
      Peeks ahead in the given InputStream instance and returns a TypeDecoder that can read the next encoded AMQP type from the stream's bytes.
      Binary readBinary​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Binary value from the given InputStream assuming that the next value in the byte stream is that type.
      ProtonBuffer readBinaryAsBuffer​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Binary value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Boolean readBoolean​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Boolean value from the given InputStream assuming that the next value in the byte stream is that type.
      boolean readBoolean​(java.io.InputStream stream, StreamDecoderState state, boolean defaultValue)
      Reads an encoded Byte value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Byte readByte​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Byte value from the given InputStream assuming that the next value in the byte stream is that type.
      byte readByte​(java.io.InputStream stream, StreamDecoderState state, byte defaultValue)
      Reads an encoded Byte value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Character readCharacter​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Character value from the given InputStream assuming that the next value in the byte stream is that type.
      char readCharacter​(java.io.InputStream stream, StreamDecoderState state, char defaultValue)
      Reads an encoded Character value from the given InputStream assuming that the next value in the byte stream is that type.
      Decimal128 readDecimal128​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Decimal128 value from the given InputStream assuming that the next value in the byte stream is that type.
      Decimal32 readDecimal32​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Decimal32 value from the given InputStream assuming that the next value in the byte stream is that type.
      Decimal64 readDecimal64​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Decimal64 value from the given InputStream assuming that the next value in the byte stream is that type.
      DeliveryTag readDeliveryTag​(java.io.InputStream stream, StreamDecoderState state)
      This method expects to read a Binary encoded type from the provided stream and constructs a DeliveryTag type that wraps the bytes encoded.
      java.lang.Double readDouble​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Double value from the given InputStream assuming that the next value in the byte stream is that type.
      double readDouble​(java.io.InputStream stream, StreamDecoderState state, double defaultValue)
      Reads an encoded Double value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Float readFloat​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Float value from the given InputStream assuming that the next value in the byte stream is that type.
      float readFloat​(java.io.InputStream stream, StreamDecoderState state, float defaultValue)
      Reads an encoded Float value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Integer readInteger​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Integer value from the given InputStream assuming that the next value in the byte stream is that type.
      int readInteger​(java.io.InputStream stream, StreamDecoderState state, int defaultValue)
      Reads an encoded Integer value from the given InputStream assuming that the next value in the byte stream is that type.
      <V> java.util.List<V> readList​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded List value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Long readLong​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Long value from the given InputStream assuming that the next value in the byte stream is that type.
      long readLong​(java.io.InputStream stream, StreamDecoderState state, long defaultValue)
      Reads an encoded Long value from the given InputStream assuming that the next value in the byte stream is that type.
      <K,​V>
      java.util.Map<K,​V>      		 readMap​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Map value from the given InputStream assuming that the next value in the byte stream is that type.
      <T> T[] readMultiple​(java.io.InputStream stream, StreamDecoderState state, java.lang.Class<T> clazz)
      Reads one or more encoded values from the given InputStream an return it as an array of Object instances which the caller must then interpret.
      StreamTypeDecoder<?> readNextTypeDecoder​(java.io.InputStream stream, StreamDecoderState state)
      Reads from the given InputStream instance and returns a StreamTypeDecoder that can read the next encoded AMQP type from the stream's bytes.
      java.lang.Object readObject​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded value from the given InputStream an return it as an Object which the caller must then interpret.
      <T> T readObject​(java.io.InputStream stream, StreamDecoderState state, java.lang.Class<T> clazz)
      Reads an encoded value from the given InputStream an return it as an Object which the caller must then interpret.
      java.lang.Short readShort​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Short value from the given InputStream assuming that the next value in the byte stream is that type.
      short readShort​(java.io.InputStream stream, StreamDecoderState state, short defaultValue)
      Reads an encoded Short value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.String readString​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded String value from the given InputStream assuming that the next value in the byte stream is that type.
      Symbol readSymbol​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded Symbol value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.String readSymbol​(java.io.InputStream stream, StreamDecoderState state, java.lang.String defaultValue)
      Reads an encoded String value from the given InputStream assuming that the next value in the byte stream is that type.
      java.lang.Long readTimestamp​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded AMQP time stamp value from the given InputStream assuming that the next value in the byte stream is that type.
      long readTimestamp​(java.io.InputStream stream, StreamDecoderState state, long defaultValue)
      Reads an encoded AMQP time stamp value from the given InputStream assuming that the next value in the byte stream is that type.
      UnsignedByte readUnsignedByte​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded UnsignedByte value from the given InputStream assuming that the next value in the byte stream is that type.
      byte readUnsignedByte​(java.io.InputStream stream, StreamDecoderState state, byte defaultValue)
      Reads an encoded UnsignedByte value from the given InputStream assuming that the next value in the byte stream is that type.
      UnsignedInteger readUnsignedInteger​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded UnsignedInteger value from the given InputStream assuming that the next value in the byte stream is that type.
      int readUnsignedInteger​(java.io.InputStream stream, StreamDecoderState state, int defaultValue)
      Reads an encoded UnsignedInteger value from the given InputStream assuming that the next value in the byte stream is that type.
      long readUnsignedInteger​(java.io.InputStream stream, StreamDecoderState state, long defaultValue)
      Reads an encoded UnsignedInteger value from the given InputStream assuming that the next value in the byte stream is that type.
      UnsignedLong readUnsignedLong​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded UnsignedLong value from the given InputStream assuming that the next value in the byte stream is that type.
      long readUnsignedLong​(java.io.InputStream stream, StreamDecoderState state, long defaultValue)
      Reads an encoded UnsignedLong value from the given InputStream assuming that the next value in the byte stream is that type.
      UnsignedShort readUnsignedShort​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded UnsignedShort value from the given InputStream assuming that the next value in the byte stream is that type.
      int readUnsignedShort​(java.io.InputStream stream, StreamDecoderState state, int defaultValue)
      Reads an encoded UnsignedShort value from the given InputStream assuming that the next value in the byte stream is that type.
      short readUnsignedShort​(java.io.InputStream stream, StreamDecoderState state, short defaultValue)
      Reads an encoded UnsignedShort value from the given InputStream assuming that the next value in the byte stream is that type.
      java.util.UUID readUUID​(java.io.InputStream stream, StreamDecoderState state)
      Reads an encoded UUID value from the given InputStream assuming that the next value in the byte stream is that type.
      <V> StreamDecoder registerDescribedTypeDecoder​(StreamDescribedTypeDecoder<V> decoder)
      Allows custom StreamDescribedTypeDecoder instances to be registered with this StreamDecoder which will be used if the described type encoding is encountered during decode operations.

    • Method Detail

      • newDecoderState

        StreamDecoderState newDecoderState()
        Creates a new StreamDecoderState instance that can be used when interacting with the Decoder. For decoding that occurs on more than one thread while sharing a single StreamDecoder instance a different state object per thread is required as the StreamDecoderState object can retain some state information during the decode process that could be corrupted if more than one thread were to share a single instance. For single threaded decoding work the StreamDecoder offers a utility cached StreamDecoderState API that will return the same instance on each call which can reduce allocation overhead and make using the StreamDecoder simpler.
        Returns:
        a newly constructed EncoderState instance.

      • getCachedDecoderState

        StreamDecoderState getCachedDecoderState()
        Return a singleton StreamDecoderState instance that is meant to be shared within single threaded decoder interactions. If more than one thread makes use of this cached StreamDecoderState the results of any decoding done using this state object is not guaranteed to be correct. The returned instance will have its reset method called to ensure that any previously stored state data is cleared before the next use.
        Returns:
        a cached StreamDecoderState linked to this Decoder instance that has been reset.

      • readBoolean

        java.lang.Boolean readBoolean​(java.io.InputStream stream,
                              StreamDecoderState state)
                       throws DecodeException
        Reads an encoded Boolean value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readBoolean

        boolean readBoolean​(java.io.InputStream stream,
                    StreamDecoderState state,
                    boolean defaultValue)
             throws DecodeException
        Reads an encoded Byte value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readByte

        java.lang.Byte readByte​(java.io.InputStream stream,
                        StreamDecoderState state)
                 throws DecodeException
        Reads an encoded Byte value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readByte

        byte readByte​(java.io.InputStream stream,
              StreamDecoderState state,
              byte defaultValue)
       throws DecodeException
        Reads an encoded Byte value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedByte

        UnsignedByte readUnsignedByte​(java.io.InputStream stream,
                              StreamDecoderState state)
                       throws DecodeException
        Reads an encoded UnsignedByte value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedByte

        byte readUnsignedByte​(java.io.InputStream stream,
                      StreamDecoderState state,
                      byte defaultValue)
               throws DecodeException
        Reads an encoded UnsignedByte value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readCharacter

        java.lang.Character readCharacter​(java.io.InputStream stream,
                                  StreamDecoderState state)
                           throws DecodeException
        Reads an encoded Character value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readCharacter

        char readCharacter​(java.io.InputStream stream,
                   StreamDecoderState state,
                   char defaultValue)
            throws DecodeException
        Reads an encoded Character value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readDecimal32

        Decimal32 readDecimal32​(java.io.InputStream stream,
                        StreamDecoderState state)
                 throws DecodeException
        Reads an encoded Decimal32 value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readDecimal64

        Decimal64 readDecimal64​(java.io.InputStream stream,
                        StreamDecoderState state)
                 throws DecodeException
        Reads an encoded Decimal64 value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readDecimal128

        Decimal128 readDecimal128​(java.io.InputStream stream,
                          StreamDecoderState state)
                   throws DecodeException
        Reads an encoded Decimal128 value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readShort

        java.lang.Short readShort​(java.io.InputStream stream,
                          StreamDecoderState state)
                   throws DecodeException
        Reads an encoded Short value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readShort

        short readShort​(java.io.InputStream stream,
                StreamDecoderState state,
                short defaultValue)
         throws DecodeException
        Reads an encoded Short value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedShort

        UnsignedShort readUnsignedShort​(java.io.InputStream stream,
                                StreamDecoderState state)
                         throws DecodeException
        Reads an encoded UnsignedShort value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedShort

        short readUnsignedShort​(java.io.InputStream stream,
                        StreamDecoderState state,
                        short defaultValue)
                 throws DecodeException
        Reads an encoded UnsignedShort value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedShort

        int readUnsignedShort​(java.io.InputStream stream,
                      StreamDecoderState state,
                      int defaultValue)
               throws DecodeException
        Reads an encoded UnsignedShort value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readInteger

        java.lang.Integer readInteger​(java.io.InputStream stream,
                              StreamDecoderState state)
                       throws DecodeException
        Reads an encoded Integer value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readInteger

        int readInteger​(java.io.InputStream stream,
                StreamDecoderState state,
                int defaultValue)
         throws DecodeException
        Reads an encoded Integer value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedInteger

        UnsignedInteger readUnsignedInteger​(java.io.InputStream stream,
                                    StreamDecoderState state)
                             throws DecodeException
        Reads an encoded UnsignedInteger value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedInteger

        int readUnsignedInteger​(java.io.InputStream stream,
                        StreamDecoderState state,
                        int defaultValue)
                 throws DecodeException
        Reads an encoded UnsignedInteger value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedInteger

        long readUnsignedInteger​(java.io.InputStream stream,
                         StreamDecoderState state,
                         long defaultValue)
                  throws DecodeException
        Reads an encoded UnsignedInteger value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readLong

        java.lang.Long readLong​(java.io.InputStream stream,
                        StreamDecoderState state)
                 throws DecodeException
        Reads an encoded Long value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readLong

        long readLong​(java.io.InputStream stream,
              StreamDecoderState state,
              long defaultValue)
       throws DecodeException
        Reads an encoded Long value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedLong

        UnsignedLong readUnsignedLong​(java.io.InputStream stream,
                              StreamDecoderState state)
                       throws DecodeException
        Reads an encoded UnsignedLong value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUnsignedLong

        long readUnsignedLong​(java.io.InputStream stream,
                      StreamDecoderState state,
                      long defaultValue)
               throws DecodeException
        Reads an encoded UnsignedLong value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readFloat

        java.lang.Float readFloat​(java.io.InputStream stream,
                          StreamDecoderState state)
                   throws DecodeException
        Reads an encoded Float value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readFloat

        float readFloat​(java.io.InputStream stream,
                StreamDecoderState state,
                float defaultValue)
         throws DecodeException
        Reads an encoded Float value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readDouble

        java.lang.Double readDouble​(java.io.InputStream stream,
                            StreamDecoderState state)
                     throws DecodeException
        Reads an encoded Double value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readDouble

        double readDouble​(java.io.InputStream stream,
                  StreamDecoderState state,
                  double defaultValue)
           throws DecodeException
        Reads an encoded Double value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readBinary

        Binary readBinary​(java.io.InputStream stream,
                  StreamDecoderState state)
           throws DecodeException
        Reads an encoded Binary value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readBinaryAsBuffer

        ProtonBuffer readBinaryAsBuffer​(java.io.InputStream stream,
                                StreamDecoderState state)
                         throws DecodeException
        Reads an encoded Binary value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source and returned in a ProtonBuffer.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readDeliveryTag

        DeliveryTag readDeliveryTag​(java.io.InputStream stream,
                            StreamDecoderState state)
                     throws DecodeException
        This method expects to read a Binary encoded type from the provided stream and constructs a DeliveryTag type that wraps the bytes encoded. If the encoding is a NULL AMQP type then this method returns null.
        Parameters:
        stream - The InputStream to read a Binary encoded value from
        state - The current encoding state.
        Returns:
        a new DeliveryTag instance or null if an AMQP NULL encoding is found.
        Throws:
        DecodeException - if an error occurs while decoding the DeliveryTag instance.

      • readString

        java.lang.String readString​(java.io.InputStream stream,
                            StreamDecoderState state)
                     throws DecodeException
        Reads an encoded String value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readSymbol

        Symbol readSymbol​(java.io.InputStream stream,
                  StreamDecoderState state)
           throws DecodeException
        Reads an encoded Symbol value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readSymbol

        java.lang.String readSymbol​(java.io.InputStream stream,
                            StreamDecoderState state,
                            java.lang.String defaultValue)
                     throws DecodeException
        Reads an encoded String value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readTimestamp

        java.lang.Long readTimestamp​(java.io.InputStream stream,
                             StreamDecoderState state)
                      throws DecodeException
        Reads an encoded AMQP time stamp value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source and return a Long with the time value.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readTimestamp

        long readTimestamp​(java.io.InputStream stream,
                   StreamDecoderState state,
                   long defaultValue)
            throws DecodeException
        Reads an encoded AMQP time stamp value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        defaultValue - A default value to return if the next encoded value is a Null encoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readUUID

        java.util.UUID readUUID​(java.io.InputStream stream,
                        StreamDecoderState state)
                 throws DecodeException
        Reads an encoded UUID value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readObject

        java.lang.Object readObject​(java.io.InputStream stream,
                            StreamDecoderState state)
                     throws DecodeException
        Reads an encoded value from the given InputStream an return it as an Object which the caller must then interpret.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not able to be decoded.

      • readObject

        <T> T readObject​(java.io.InputStream stream,
                 StreamDecoderState state,
                 java.lang.Class<T> clazz)
          throws DecodeException
        Reads an encoded value from the given InputStream an return it as an Object which the caller must then interpret.
        Type Parameters:
        T - the type that will be used when casting and returning the decoded value.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        clazz - The Class type that should be used to cast the returned value.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not able to be decoded.

      • readMultiple

        <T> T[] readMultiple​(java.io.InputStream stream,
                     StreamDecoderState state,
                     java.lang.Class<T> clazz)
              throws DecodeException
        Reads one or more encoded values from the given InputStream an return it as an array of Object instances which the caller must then interpret.
        Type Parameters:
        T - the type that will be used when casting and returning the decoded value.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        clazz - The Class type that should be used to cast the returned array.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not able to be decoded.

      • readMap

        <K,​V> java.util.Map<K,​V> readMap​(java.io.InputStream stream,
                                             StreamDecoderState state)
                                      throws DecodeException
        Reads an encoded Map value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readList

        <V> java.util.List<V> readList​(java.io.InputStream stream,
                               StreamDecoderState state)
                        throws DecodeException
        Reads an encoded List value from the given InputStream assuming that the next value in the byte stream is that type. The operation fails if the next encoded type is not what was expected. If the caller wishes to recover from failed decode attempt they should mark the and reset the input to make a further read attempt.
        Parameters:
        stream - The InputStream where the read operation takes place.
        state - The DecoderState that the decoder can use when decoding.
        Returns:
        the value read from the provided byte source.
        Throws:
        DecodeException - if the value fails to decode is not of the expected type,

      • readNextTypeDecoder

        StreamTypeDecoder<?> readNextTypeDecoder​(java.io.InputStream stream,
                                         StreamDecoderState state)
                                  throws DecodeException
        Reads from the given InputStream instance and returns a StreamTypeDecoder that can read the next encoded AMQP type from the stream's bytes. If an error occurs attempting to read and determine the next type decoder an DecodeException is thrown.
        Parameters:
        stream - The stream to read from to determine the next TypeDecoder needed.
        state - The DecoderState value that can be used for intermediate decoding tasks.
        Returns:
        a StreamTypeDecoder instance that can read the next type in the stream.
        Throws:
        DecodeException - if an error occurs while reading the next type decoder.

      • peekNextTypeDecoder

        StreamTypeDecoder<?> peekNextTypeDecoder​(java.io.InputStream stream,
                                         StreamDecoderState state)
                                  throws DecodeException
        Peeks ahead in the given InputStream instance and returns a TypeDecoder that can read the next encoded AMQP type from the stream's bytes. If an error occurs attempting to read and determine the next type decoder an DecodeException is thrown. The underlying stream is not modified as a result of the peek operation and the returned TypeDecoder will fail to properly read the type until the encoding bytes are read. If the provided stream does not offer support for the mark API than this method can throw an UnsupportedOperationException.
        Parameters:
        stream - The stream to read from to determine the next TypeDecoder needed.
        state - The DecoderState value that can be used for intermediate decoding tasks.
        Returns:
        a TypeDecoder instance that can provide insight into the next type in the stream.
        Throws:
        DecodeException - if an error occurs while peeking ahead for the next type decoder.