package de.thedevstack.conversationsplus.xmpp.pubsub;

import de.thedevstack.conversationsplus.xml.Element;
import de.thedevstack.conversationsplus.xmpp.stanzas.IqPacket;

/**
 * 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);
    }
}