com.microsoft.azure.storage.queue

Class CloudQueueMessage

java.lang.Object

com.microsoft.azure.storage.queue.CloudQueueMessage

public class CloudQueueMessage
extends Object

Represents a message in the Microsoft Azure Queue service.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	messageContent Holds the message content.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudQueueMessage() Initializes a new instance of the CloudQueueMessage class (used internally).
	CloudQueueMessage(byte[] content) Initializes a new instance of the CloudQueueMessage class with a byte array containing the message.
	CloudQueueMessage(String content) Initializes a new instance of the CloudQueueMessage class with a String containing the message.

Method Summary

Modifier and Type	Method and Description
int	getDequeueCount() Gets the dequeue count.
Date	getExpirationTime() Gets the time that the message expires.
String	getId() Gets the message ID.
Date	getInsertionTime() Gets the time the message was added to the queue.
byte[]	getMessageContentAsByte() Gets the content of the message as a byte array.
String	getMessageContentAsString() Gets the content of the message as a string.
protected String	getMessageContentForTransfer(boolean shouldEncodeMessage, QueueRequestOptions options) Gets the content of the message for transfer (internal use only).
String	getMessageId() Gets the message ID.
protected com.microsoft.azure.storage.queue.QueueMessageType	getMessageType() Gets the message type.
Date	getNextVisibleTime() Gets the time that the message will next be visible.
String	getPopReceipt() Gets the message's pop receipt.
protected void	setDequeueCount(int dequeueCount) Sets the dequeue count.
protected void	setExpirationTime(Date expirationTime) Sets the expiration time for the message.
protected void	setInsertionTime(Date insertionTime) Sets the java.util.Date representing the time the message was added to the queue.
void	setMessageContent(byte[] content) Sets the content of the message as a byte array.
void	setMessageContent(String content) Sets the content of the message as a String.
protected void	setMessageId(String id) Sets the message ID.
protected void	setMessageType(com.microsoft.azure.storage.queue.QueueMessageType messageType) Sets the message's type
protected void	setNextVisibleTime(Date nextVisibleTime) Sets the time for the message to become visible in the queue.
protected void	setPopReceipt(String popReceipt) Sets the message's pop receipt.

Methods inherited from class java.lang.Object

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

Field Detail

messageContent

protected String messageContent

Holds the message content.

Constructor Detail

CloudQueueMessage

protected CloudQueueMessage()

Initializes a new instance of the CloudQueueMessage class (used internally).

CloudQueueMessage

public CloudQueueMessage(byte[] content)

Initializes a new instance of the CloudQueueMessage class with a byte array containing the message.

Parameters:

content - A byte array which contains the message.

CloudQueueMessage

public CloudQueueMessage(String content)

Initializes a new instance of the CloudQueueMessage class with a String containing the message.

Parameters:

content - A String which contains the message.

Method Detail

getDequeueCount

public final int getDequeueCount()

Gets the dequeue count.

Returns:

An int which contains the dequeue count.

getExpirationTime

public final Date getExpirationTime()

Gets the time that the message expires.

Returns:

A java.util.Date object which represents the time that the message expires.

getId

public final String getId()

Gets the message ID.

Returns:

A String which contains the message ID.

getInsertionTime

public final Date getInsertionTime()

Gets the time the message was added to the queue.

Returns:

A java.util.Date which represents the time the message was added to the queue.

getMessageContentAsByte

public final byte[] getMessageContentAsByte()
                                     throws StorageException

Gets the content of the message as a byte array.

Returns:

A byte array which contains the content of the message.

Throws:

StorageException - If a storage service error occurred.

getMessageContentAsString

public final String getMessageContentAsString()
                                       throws StorageException

Gets the content of the message as a string.

Returns:

A String which contains the content of the message.

Throws:

StorageException - If a storage service error occurred.

getMessageContentForTransfer

protected final String getMessageContentForTransfer(boolean shouldEncodeMessage,
                                                    QueueRequestOptions options)
                                             throws StorageException

Gets the content of the message for transfer (internal use only).

Parameters:

shouldEncodeMessage - Indicates if the message should be encoded.

options - A QueueRequestOptions object that specifies additional options for the request.

Returns:

A String which contains the content of the message.

Throws:

StorageException - If a storage service error occurred.

getMessageId

public final String getMessageId()

Gets the message ID.

Returns:

A String which contains the message ID.

getMessageType

protected final com.microsoft.azure.storage.queue.QueueMessageType getMessageType()

Gets the message type.

Returns:

A QueueMessageType value which represents the message type.

getNextVisibleTime

public final Date getNextVisibleTime()

Gets the time that the message will next be visible.

Returns:

A java.util.Date with the time that the message will next be visible.

getPopReceipt

public final String getPopReceipt()

Gets the message's pop receipt.

Returns:

A String which contains the message's pop receipt.

setDequeueCount

protected final void setDequeueCount(int dequeueCount)

Sets the dequeue count.

Parameters:

dequeueCount - An int which contains the dequeue count.

setExpirationTime

protected final void setExpirationTime(Date expirationTime)

Sets the expiration time for the message.

Parameters:

expirationTime - The java.util.Date which represents the expiration time to set on the message.

setInsertionTime

protected final void setInsertionTime(Date insertionTime)

Sets the java.util.Date representing the time the message was added to the queue.

Parameters:

insertiontTime - The java.util.Date representing the time the message was added to the queue.

setMessageContent

public final void setMessageContent(byte[] content)

Sets the content of the message as a byte array.

Parameters:

content - A byte array which contains the content of the message.

setMessageContent

public final void setMessageContent(String content)

Sets the content of the message as a String.

Parameters:

content - A String which contains the content of the message.

setMessageId

protected final void setMessageId(String id)

Sets the message ID.

Parameters:

id - A String which represents the message ID.

setMessageType

protected final void setMessageType(com.microsoft.azure.storage.queue.QueueMessageType messageType)

Sets the message's type

Parameters:

messageType - A QueueMessageType value which represents the message type.

setNextVisibleTime

protected final void setNextVisibleTime(Date nextVisibleTime)

Sets the time for the message to become visible in the queue.

Parameters:

nextVisibleTime - A java.util.Date with the time that the message will next be visible.

setPopReceipt

protected final void setPopReceipt(String popReceipt)

Sets the message's pop receipt.

Parameters:

popReceipt - A String which contains the message's pop receipt.