Class Modified
- java.lang.Object
-
- com.swiftmq.amqp.v100.types.AMQPType
-
- com.swiftmq.amqp.v100.types.AMQPList
-
- com.swiftmq.amqp.v100.generated.messaging.delivery_state.Modified
-
- All Implemented Interfaces:
DeliveryStateIF
,OutcomeIF
public class Modified extends AMQPList implements DeliveryStateIF, OutcomeIF
At the source the modified outcome means that the message is no longer acquired by the receiver, and has been made available for (re-)delivery to the same or other targets receiving from the node. The message has been changed at the node in the ways indicated by the fields of the outcome. As modified is a terminal outcome, transfer of payload data will not be able to be resumed if the link becomes suspended. A delivery may become modified at the source even before all transfer frames have been sent. This does not imply that the remaining transfers for the delivery will not be sent. The source MAY spontaneously attain the modified outcome for a message (for example the source may implement some sort of time-bound acquisition lock, after which the acquisition of a message at a node is revoked to allow for delivery to an alternative consumer with the message modified in some way to denote the previous failed, e.g., with delivery-failed set to true).
At the target, the modified outcome is used to indicate that a given transfer was not and will not be acted upon, and that the message should be modified in the specified ways at the node.
- 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 java.lang.String
DESCRIPTOR_NAME
AMQPDescribedConstructor
nameConstructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(DeliveryStateVisitor visitor)
Accept method for a DeliveryState visitor.void
accept(OutcomeVisitor visitor)
Accept method for a Outcome visitor.AMQPDescribedConstructor
getArrayConstructor()
Returns an array constructor (internal use)AMQPBoolean
getDeliveryFailed()
Returns the optional DeliveryFailed field.Fields
getMessageAnnotations()
Returns the optional MessageAnnotations field.int
getPredictedSize()
Returns the predicted size of this Modified.AMQPBoolean
getUndeliverableHere()
Returns the optional UndeliverableHere field.java.lang.String
getValueString()
Returns the value string representation of the type.boolean
hasDescriptor()
Return whether this Modified has a descriptorvoid
setDeliveryFailed(AMQPBoolean deliveryFailed)
Sets the optional DeliveryFailed field.void
setMessageAnnotations(Fields messageAnnotations)
Sets the optional MessageAnnotations field.void
setUndeliverableHere(AMQPBoolean undeliverableHere)
Sets the optional UndeliverableHere field.java.lang.String
toString()
void
writeContent(java.io.DataOutput out)
Write the content of this type to a DataOutput.-
Methods inherited from class com.swiftmq.amqp.v100.types.AMQPList
getValue, readContent, setValue
-
Methods inherited from class com.swiftmq.amqp.v100.types.AMQPType
getCode, getConstructor, getName, isWriteCode, resetConstructor, setCode, setConstructor, setWriteCode
-
-
-
-
Field Detail
-
DESCRIPTOR_NAME
public static java.lang.String DESCRIPTOR_NAME
-
DESCRIPTOR_CODE
public static long DESCRIPTOR_CODE
-
codeConstructor
public AMQPDescribedConstructor codeConstructor
-
nameConstructor
public AMQPDescribedConstructor nameConstructor
-
-
Method Detail
-
hasDescriptor
public boolean hasDescriptor()
Return whether this Modified has a descriptor- Overrides:
hasDescriptor
in classAMQPType
- Returns:
- true/false
-
accept
public void accept(DeliveryStateVisitor visitor)
Accept method for a DeliveryState visitor.- Specified by:
accept
in interfaceDeliveryStateIF
- Parameters:
visitor
- DeliveryState visitor
-
accept
public void accept(OutcomeVisitor visitor)
Accept method for a Outcome visitor.
-
getDeliveryFailed
public AMQPBoolean getDeliveryFailed()
Returns the optional DeliveryFailed field.- Returns:
- DeliveryFailed
-
setDeliveryFailed
public void setDeliveryFailed(AMQPBoolean deliveryFailed)
Sets the optional DeliveryFailed field.- Parameters:
deliveryFailed
- DeliveryFailed
-
getUndeliverableHere
public AMQPBoolean getUndeliverableHere()
Returns the optional UndeliverableHere field.- Returns:
- UndeliverableHere
-
setUndeliverableHere
public void setUndeliverableHere(AMQPBoolean undeliverableHere)
Sets the optional UndeliverableHere field.- Parameters:
undeliverableHere
- UndeliverableHere
-
getMessageAnnotations
public Fields getMessageAnnotations()
Returns the optional MessageAnnotations field.- Returns:
- MessageAnnotations
-
setMessageAnnotations
public void setMessageAnnotations(Fields messageAnnotations)
Sets the optional MessageAnnotations field.- Parameters:
messageAnnotations
- MessageAnnotations
-
getPredictedSize
public int getPredictedSize()
Returns the predicted size of this Modified. The predicted size may be greater than the actual size but it can never be less.- Specified by:
getPredictedSize
in interfaceDeliveryStateIF
- Specified by:
getPredictedSize
in interfaceOutcomeIF
- Overrides:
getPredictedSize
in classAMQPList
- Returns:
- predicted size
-
getArrayConstructor
public AMQPDescribedConstructor getArrayConstructor() throws java.io.IOException
Returns an array constructor (internal use)- Returns:
- array constructor
- Throws:
java.io.IOException
-
writeContent
public void writeContent(java.io.DataOutput out) throws java.io.IOException
Description copied from class:AMQPType
Write the content of this type to a DataOutput.- Overrides:
writeContent
in classAMQPList
- Parameters:
out
- DataOutput- Throws:
java.io.IOException
- on error
-
getValueString
public java.lang.String getValueString()
Description copied from class:AMQPType
Returns the value string representation of the type.- Specified by:
getValueString
in interfaceDeliveryStateIF
- Specified by:
getValueString
in interfaceOutcomeIF
- Overrides:
getValueString
in classAMQPList
- Returns:
- value string
-
-