Package com.swiftmq.amqp.v100.generated.messaging.message_format

Class MessageAnnotations

java.lang.Object

com.swiftmq.amqp.v100.types.AMQPType

com.swiftmq.amqp.v100.types.AMQPMap

com.swiftmq.amqp.v100.generated.messaging.message_format.Annotations

com.swiftmq.amqp.v100.generated.messaging.message_format.MessageAnnotations

All Implemented Interfaces:

SectionIF

public class MessageAnnotations
extends Annotations
implements SectionIF

The message-annotations section is used for properties of the message which are aimed at the infrastructure and should be propagated across every delivery step. Message annotations convey information about the message. Intermediaries MUST propagate the annotations unless the annotations are explicitly augmented or modified (e.g., by the use of the outcome).

The capabilities negotiated on link and on the and may be used to establish which annotations a peer understands; however, in a network of AMQP intermediaries it may not be possible to know if every intermediary will understand the annotation. Note that for some annotations it may not be necessary for the intermediary to understand their purpose, i.e., they could be used purely as an attribute which can be filtered on.

A registry of defined annotations and their meanings is maintained [ AMQPMESSANN ].

If the message-annotations section is omitted, it is equivalent to a message-annotations section containing an empty map of annotations.

Version:

AMQP Version v100. Generation Date: Wed Apr 18 14:09:32 CEST 2012

Author:

IIT Software GmbH, Bremen/Germany, (c) 2012, All Rights Reserved

Field Summary

Fields

Modifier and Type	Field	Description
AMQPDescribedConstructor	codeConstructor
static long	DESCRIPTOR_CODE
static String	DESCRIPTOR_NAME
AMQPDescribedConstructor	nameConstructor

Constructor Summary

Constructors

Constructor	Description
MessageAnnotations(Map initValue)	Constructs a MessageAnnotations.

Method Summary

Modifier and Type	Method	Description
void	accept(SectionVisitor visitor)	Accept method for a Section visitor.
boolean	hasDescriptor()	Return whether this MessageAnnotations has a descriptor
String	toString()
void	writeContent(DataOutput out)	Write the content of this type to a DataOutput.

Methods inherited from class com.swiftmq.amqp.v100.types.AMQPMap

getPredictedSize, getValue, getValueString, readContent, setValue

Methods inherited from class com.swiftmq.amqp.v100.types.AMQPType

getCode, getConstructor, getName, isWriteCode, resetConstructor, setCode, setConstructor, setWriteCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.swiftmq.amqp.v100.generated.messaging.message_format.SectionIF

getPredictedSize, getValueString

Field Details

DESCRIPTOR_NAME

public static String DESCRIPTOR_NAME

DESCRIPTOR_CODE

public static long DESCRIPTOR_CODE

codeConstructor

public AMQPDescribedConstructor codeConstructor

nameConstructor

public AMQPDescribedConstructor nameConstructor

Constructor Details

MessageAnnotations

public MessageAnnotations(Map initValue)
                   throws IOException

Constructs a MessageAnnotations.

Parameters:

initValue - initial value

Method Details

accept

public void accept(SectionVisitor visitor)

Accept method for a Section visitor.

Specified by:

accept in interface SectionIF

Parameters:

visitor - Section visitor

hasDescriptor

public boolean hasDescriptor()

Return whether this MessageAnnotations has a descriptor

Overrides:

hasDescriptor in class AMQPType

Returns:

true/false

writeContent

public void writeContent(DataOutput out)
                  throws IOException

Description copied from class: AMQPType

Write the content of this type to a DataOutput.

Overrides:

writeContent in class AMQPMap

Parameters:

out - DataOutput

Throws:

IOException - on error

toString

public String toString()

Overrides:

toString in class Annotations