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.

Constructor Summary

Constructors

Constructor and Description
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

Methods

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.
String	getMessageId() Gets the message ID.
Date	getNextVisibleTime() Gets the time that the message will next be visible.
String	getPopReceipt() Gets the message's pop receipt.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

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.

getMessageId

public final String getMessageId()

Gets the message ID.

Returns:

A String which contains the message ID.

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.

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.