QueueItem Class

Package:

com.azure.storage.queue.models

Maven Artifact:

com.azure:azure-storage-queue:12.21.0

• java.lang.Object
• • com.azure.storage.queue.models.QueueItem

Implements

XmlSerializable<QueueItem>

public final class QueueItem
implements XmlSerializable<QueueItem>

An Azure Storage Queue.

Constructor Summary

Constructor	Description
QueueItem()	Creates an instance of QueueItem class.

Method Summary

Modifier and Type	Method and Description
static QueueItem	fromXml(XmlReader xmlReader) Reads an instance of QueueItem from the XmlReader.
static QueueItem	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of QueueItem from the XmlReader.
Map<String,String>	getMetadata() Get the metadata property: Dictionary of .
String	getName() Get the name property: The name of the Queue.
QueueItem	setMetadata(Map<String,String> metadata) Set the metadata property: Dictionary of .
QueueItem	setName(String name) Set the name property: The name of the Queue.
XmlWriter	toXml(XmlWriter xmlWriter)
XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueueItem

public QueueItem()

Creates an instance of QueueItem class.

Method Details

fromXml

public static QueueItem fromXml(XmlReader xmlReader)

Reads an instance of QueueItem from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of QueueItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

fromXml

public static QueueItem fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of QueueItem from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.

Returns:

An instance of QueueItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

getMetadata

public Map getMetadata()

Get the metadata property: Dictionary of .

Returns:

the metadata value.

getName

public String getName()

Get the name property: The name of the Queue.

Returns:

the name value.

setMetadata

public QueueItem setMetadata(Map metadata)

Set the metadata property: Dictionary of .

Parameters:

metadata - the metadata value to set.

Returns:

the QueueItem object itself.

setName

public QueueItem setName(String name)

Set the name property: The name of the Queue.

Parameters:

name - the name value to set.

Returns:

the QueueItem object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException