From 56b5eae48072a05da28c35aff5fe719e057b13ad Mon Sep 17 00:00:00 2001
From: steckbrief <steckbrief@chefmail.de>
Date: Thu, 26 May 2016 20:34:05 +0200
Subject: Fixed javadoc of PubSub Element Generation/Parsing

---
 .../xmpp/pubsub/PubSubPacket.java                  | 43 +++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

(limited to 'src/main/java/de/thedevstack/conversationsplus/xmpp/pubsub/PubSubPacket.java')

diff --git a/src/main/java/de/thedevstack/conversationsplus/xmpp/pubsub/PubSubPacket.java b/src/main/java/de/thedevstack/conversationsplus/xmpp/pubsub/PubSubPacket.java
index fea1383c..fe485de0 100644
--- a/src/main/java/de/thedevstack/conversationsplus/xmpp/pubsub/PubSubPacket.java
+++ b/src/main/java/de/thedevstack/conversationsplus/xmpp/pubsub/PubSubPacket.java
@@ -4,28 +4,69 @@ import de.thedevstack.conversationsplus.xml.Element;
 import de.thedevstack.conversationsplus.xmpp.stanzas.IqPacket;
 
 /**
- * Created by tzur on 15.01.2016.
+ * Representation of a PubSub IQ packet as defined in XEP-0060.
+ * <br>One example:
+ * <pre>
+ *   <iq type='get'
+ *       from='romeo@montague.lit'
+ *       to='pubsub.shakespeare.lit'
+ *       id='items1'>
+ *      <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+ *          <items node='urn:xmpp:pubsub:subscription'/>
+ *      </pubsub>
+ *   </iq>
+ * </pre>
+ * @see <a href="http://xmpp.org/extensions/xep-0330.html">http://xmpp.org/extensions/xep-0060.html</a>
  */
 public class PubSubPacket extends IqPacket {
+    /**
+     * The namespace of pubsub.
+     */
     public static final String NAMESPACE = "http://jabber.org/protocol/pubsub";
+    /**
+     * The name of the root element.
+     */
     public static final String ELEMENT_NAME = "pubsub";
+    /**
+     * The PubSub element - everything which is added to this packet is a child of this element.
+     */
     private Element pubSubElement;
 
+    /**
+     * Instantiate the PubSubPacket for the given type.
+     * @param type the IqPacket.TYPE
+     */
     public PubSubPacket(IqPacket.TYPE type) {
         super(type);
         this.pubSubElement = super.addChild(PubSubPacket.ELEMENT_NAME, PubSubPacket.NAMESPACE);
     }
 
+    /**
+     * Adds an element to the PubSub element instead of the IqPacket.
+     * @param child the children to be added
+     * @return the added children
+     */
     @Override
     public Element addChild(Element child) {
         return this.pubSubElement.addChild(child);
     }
 
+    /**
+     * Adds an element to the PubSub element instead of the IqPacket.
+     * @param name name of the children to be added
+     * @return the added children
+     */
     @Override
     public Element addChild(String name) {
         return this.pubSubElement.addChild(name);
     }
 
+    /**
+     * Adds an element to the PubSub element instead of the IqPacket.
+     * @param name name of the children to be added
+     * @param xmlns namespace of the children to be added
+     * @return the added children
+     */
     @Override
     public Element addChild(String name, String xmlns) {
         return this.pubSubElement.addChild(name, xmlns);
-- 
cgit v1.2.3