Package org.apache.qpid.protonj2.codec
Interface TypeDecoder<V>
-
- Type Parameters:
V
- The type that will be returned when this decoder reads a value.
- All Known Subinterfaces:
BinaryTypeDecoder
,DescribedTypeDecoder<V>
,ListTypeDecoder
,MapTypeDecoder
,PrimitiveArrayTypeDecoder
,PrimitiveTypeDecoder<V>
,StringTypeDecoder
,SymbolTypeDecoder
- All Known Implementing Classes:
AbstractArrayTypeDecoder
,AbstractBinaryTypeDecoder
,AbstractDescribedTypeDecoder
,AbstractListTypeDecoder
,AbstractMapTypeDecoder
,AbstractPrimitiveTypeDecoder
,AbstractStringTypeDecoder
,AbstractSymbolTypeDecoder
,AcceptedTypeDecoder
,AmqpSequenceTypeDecoder
,AmqpValueTypeDecoder
,ApplicationPropertiesTypeDecoder
,Array32TypeDecoder
,Array8TypeDecoder
,AttachTypeDecoder
,BeginTypeDecoder
,Binary32TypeDecoder
,Binary8TypeDecoder
,BooleanFalseTypeDecoder
,BooleanTrueTypeDecoder
,BooleanTypeDecoder
,ByteTypeDecoder
,CharacterTypeDecoder
,CloseTypeDecoder
,CoordinatorTypeDecoder
,DataTypeDecoder
,Decimal128TypeDecoder
,Decimal32TypeDecoder
,Decimal64TypeDecoder
,DeclaredTypeDecoder
,DeclareTypeDecoder
,DeleteOnCloseTypeDecoder
,DeleteOnNoLinksOrMessagesTypeDecoder
,DeleteOnNoLinksTypeDecoder
,DeleteOnNoMessagesTypeDecoder
,DeliveryAnnotationsTypeDecoder
,DetachTypeDecoder
,DischargeTypeDecoder
,DispositionTypeDecoder
,DoubleTypeDecoder
,EndTypeDecoder
,ErrorConditionTypeDecoder
,FloatTypeDecoder
,FlowTypeDecoder
,FooterTypeDecoder
,HeaderTypeDecoder
,Integer32TypeDecoder
,Integer8TypeDecoder
,List0TypeDecoder
,List32TypeDecoder
,List8TypeDecoder
,Long8TypeDecoder
,LongTypeDecoder
,Map32TypeDecoder
,Map8TypeDecoder
,MessageAnnotationsTypeDecoder
,ModifiedTypeDecoder
,NullTypeDecoder
,OpenTypeDecoder
,PropertiesTypeDecoder
,ReceivedTypeDecoder
,RejectedTypeDecoder
,ReleasedTypeDecoder
,SaslChallengeTypeDecoder
,SaslInitTypeDecoder
,SaslMechanismsTypeDecoder
,SaslOutcomeTypeDecoder
,SaslResponseTypeDecoder
,ShortTypeDecoder
,SourceTypeDecoder
,String32TypeDecoder
,String8TypeDecoder
,Symbol32TypeDecoder
,Symbol8TypeDecoder
,TargetTypeDecoder
,TimestampTypeDecoder
,TransactionStateTypeDecoder
,TransferTypeDecoder
,UnknownDescribedTypeDecoder
,UnsignedByteTypeDecoder
,UnsignedInteger0TypeDecoder
,UnsignedInteger32TypeDecoder
,UnsignedInteger8TypeDecoder
,UnsignedLong0TypeDecoder
,UnsignedLong64TypeDecoder
,UnsignedLong8TypeDecoder
,UnsignedShortTypeDecoder
,UUIDTypeDecoder
public interface TypeDecoder<V>
Interface for an decoder of a specific AMQP Type.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Class<V>
getTypeClass()
boolean
isArrayType()
V[]
readArrayElements(ProtonBuffer buffer, DecoderState state, int count)
Reads a series of this type that have been encoded into the body of an Array type.V
readValue(ProtonBuffer buffer, DecoderState state)
Reads the next type from the given buffer and returns it.void
skipValue(ProtonBuffer buffer, DecoderState state)
Skips over the bytes that compose the type this descriptor decodes.
-
-
-
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.
-
-