|
Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smackx.pubsub.NodeExtension
org.jivesoftware.smackx.pubsub.ItemsExtension
public class ItemsExtension
This class is used to for multiple purposes.
Please note, this class is used for internal purposes, and is not required for usage of pubsub functionality.
| Nested Class Summary | |
|---|---|
static class |
ItemsExtension.ItemsElementType
|
| Field Summary | |
|---|---|
protected List<? extends PacketExtension> |
items
|
protected Boolean |
notify
|
protected ItemsExtension.ItemsElementType |
type
|
| Constructor Summary | |
|---|---|
ItemsExtension(ItemsExtension.ItemsElementType itemsType,
String nodeId,
List<? extends PacketExtension> items)
Construct an instance with a list representing items that have been published or deleted. |
|
ItemsExtension(String nodeId,
List<? extends PacketExtension> items,
boolean notify)
Construct an instance with a list representing items that have been published or deleted. |
|
| Method Summary | |
|---|---|
List<PacketExtension> |
getExtensions()
Get the list of embedded PacketExtension objects. |
List<? extends PacketExtension> |
getItems()
Gets the items related to the type of request or event. |
ItemsExtension.ItemsElementType |
getItemsElementType()
Get the type of element |
boolean |
getNotify()
Gets the value of the optional attribute related to the ItemsExtension.ItemsElementType. |
String |
toString()
|
String |
toXML()
Returns the XML representation of the PacketExtension. |
| Methods inherited from class org.jivesoftware.smackx.pubsub.NodeExtension |
|---|
getElementName, getNamespace, getNode |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.jivesoftware.smack.packet.PacketExtension |
|---|
getElementName, getNamespace |
| Field Detail |
|---|
protected ItemsExtension.ItemsElementType type
protected Boolean notify
protected List<? extends PacketExtension> items
| Constructor Detail |
|---|
public ItemsExtension(ItemsExtension.ItemsElementType itemsType, String nodeId, List<? extends PacketExtension> items)
Valid scenarios are:
ItemsExtension.ItemsElementType.items, items = list of Item and an
optional value for the max_items attribute.
ItemsExtension.ItemsElementType.retract, items = list of Item containing
only id's and an optional value for the notify attribute.
ItemsExtension.ItemsElementType.items, items = list of Item and
attributeValue = null
ItemsExtension.ItemsElementType.items, items = list of RetractItem and
attributeValue = null
itemsType - Type of representationnodeId - The node to which the items are being sent or deleteditems - The list of Item or RetractItemattributeValue - The value of the max_itemspublic ItemsExtension(String nodeId, List<? extends PacketExtension> items, boolean notify)
Valid scenarios are:
ItemsExtension.ItemsElementType.items, items = list of Item and an
optional value for the max_items attribute.
ItemsExtension.ItemsElementType.retract, items = list of Item containing
only id's and an optional value for the notify attribute.
ItemsExtension.ItemsElementType.items, items = list of Item and
attributeValue = null
ItemsExtension.ItemsElementType.items, items = list of RetractItem and
attributeValue = null
itemsType - Type of representationnodeId - The node to which the items are being sent or deleteditems - The list of Item or RetractItemattributeValue - The value of the max_items| Method Detail |
|---|
public ItemsExtension.ItemsElementType getItemsElementType()
public List<PacketExtension> getExtensions()
EmbeddedPacketExtensionPacketExtension objects.
getExtensions in interface EmbeddedPacketExtensionPacketExtensionpublic List<? extends PacketExtension> getItems()
Item, RetractItem, or null
public boolean getNotify()
ItemsExtension.ItemsElementType.
public String toXML()
PacketExtension
toXML in interface PacketExtensiontoXML in class NodeExtensionpublic String toString()
toString in class NodeExtension
|
Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||