[pubsub] Rework NodeExtension.toXML()

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AffiliationsExtension.java

@@ -32,7 +32,6 @@ import org.jivesoftware.smackx.pubsub.Affiliation.AffiliationNamespace;
  */
 public class AffiliationsExtension extends NodeExtension {
     protected List<Affiliation> items = Collections.emptyList();
-    private final String node;
 
     public AffiliationsExtension() {
         this(null);
@@ -51,9 +50,8 @@ public class AffiliationsExtension extends NodeExtension {
     }
 
     public AffiliationsExtension(AffiliationNamespace affiliationsNamespace, List<Affiliation> subList, String node) {
-        super(affiliationsNamespace.type);
+        super(affiliationsNamespace.type, node);
         items = subList;
-        this.node = node;
     }
 
     public List<Affiliation> getAffiliations() {
@@ -61,19 +59,14 @@ public class AffiliationsExtension extends NodeExtension {
     }
 
     @Override
-    public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
         if ((items == null) || (items.size() == 0)) {
-            return super.toXML(enclosingNamespace);
+            xml.closeEmptyElement();
+            return;
         }
-        else {
+
-            // Can't use XmlStringBuilder(this), because we don't want the namespace to be included
-            XmlStringBuilder xml = new XmlStringBuilder();
-            xml.halfOpenElement(getElementName());
-            xml.optAttribute("node", node);
         xml.rightAngleBracket();
         xml.append(items);
         xml.closeElement(this);
-            return xml;
-        }
     }
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNode.java

@@ -16,6 +16,8 @@
  */
 package org.jivesoftware.smackx.pubsub;
 
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
 import org.jivesoftware.smackx.xdata.packet.DataForm;
 
 /**
@@ -69,26 +71,14 @@ public class FormNode extends NodeExtension {
     }
 
     @Override
-    public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
         if (configForm == null) {
-            return super.toXML(enclosingNamespace);
+            xml.closeEmptyElement();
+            return;
         }
-        else {
-            StringBuilder builder = new StringBuilder("<");
-            builder.append(getElementName());
 
-            if (getNode() != null) {
+        xml.append(configForm);
-                builder.append(" node='");
+        xml.closeElement(this);
-                builder.append(getNode());
-                builder.append("'>");
-            }
-            else
-                builder.append('>');
-            builder.append(configForm.toXML());
-            builder.append("</");
-            builder.append(getElementName() + '>');
-            return builder.toString();
-        }
     }
 
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/GetItemsRequest.java

@@ -54,13 +54,9 @@ public class GetItemsRequest extends NodeExtension {
     }
 
     @Override
-    public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder xml = new XmlStringBuilder();
-        xml.halfOpenElement(getElementName());
-        xml.attribute("node", getNode());
         xml.optAttribute("subid", getSubscriptionId());
         xml.optIntAttribute("max_items", getMaxItems());
         xml.closeEmptyElement();
-        return xml;
     }
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java

@@ -150,21 +150,9 @@ public class Item extends NodeExtension {
     }
 
     @Override
-    public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder xml = getCommonXml();
-
-        xml.closeEmptyElement();
-
-        return xml;
-    }
-
-    protected final XmlStringBuilder getCommonXml() {
-        XmlStringBuilder xml = new XmlStringBuilder(this);
-
         xml.optAttribute("id", getId());
-        xml.optAttribute("node", getNode());
+        xml.closeEmptyElement();
-
-        return xml;
     }
 
     @Override

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java

@@ -20,6 +20,7 @@ import java.util.List;
 
 import org.jivesoftware.smack.packet.ExtensionElement;
 import org.jivesoftware.smack.packet.NamedElement;
+import org.jivesoftware.smack.util.XmlStringBuilder;
 
 /**
  * This class is used for multiple purposes.
@@ -150,35 +151,21 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
     }
 
     @Override
-    public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
         if ((items == null) || (items.size() == 0)) {
-            return super.toXML(enclosingNamespace);
+            xml.closeEmptyElement();
+            return;
         }
-        else {
-            StringBuilder builder = new StringBuilder("<");
-            builder.append(getElementName());
-            builder.append(" node='");
-            builder.append(getNode());
 
         if (notify != null) {
-                builder.append("' ");
+            xml.attribute(type.getElementAttribute(), notify);
-                builder.append(type.getElementAttribute());
+            xml.rightAngleBracket();
-                builder.append("='");
+        } else {
-                builder.append(notify.equals(Boolean.TRUE) ? 1 : 0);
+            xml.rightAngleBracket();
-                builder.append("'>");
+            xml.append(items);
-            }
-            else {
-                builder.append("'>");
-                for (NamedElement item : items) {
-                    builder.append(item.toXML());
-                }
         }
 
-            builder.append("</");
+        xml.closeElement(this);
-            builder.append(getElementName());
-            builder.append('>');
-            return builder.toString();
-        }
     }
 
     @Override

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java

@@ -17,6 +17,8 @@
 package org.jivesoftware.smackx.pubsub;
 
 import org.jivesoftware.smack.packet.ExtensionElement;
+import org.jivesoftware.smack.packet.XmlEnvironment;
+import org.jivesoftware.smack.util.XmlStringBuilder;
 
 import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace;
 
@@ -78,8 +80,17 @@ public class NodeExtension implements ExtensionElement {
     }
 
     @Override
-    public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    public final XmlStringBuilder toXML(XmlEnvironment enclosingNamespace) {
-        return '<' + getElementName() + (node == null ? "" : " node='" + node + '\'') + "/>";
+        XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
+        xml.optAttribute("node", node);
+
+        addXml(xml);
+
+        return xml;
+    }
+
+    protected void addXml(XmlStringBuilder xml) {
+        xml.closeEmptyElement();
     }
 
     @Override

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/OptionsExtension.java

@@ -50,13 +50,15 @@ public class OptionsExtension extends NodeExtension {
     }
 
     @Override
-    public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder xml = new XmlStringBuilder();
+        xml.rightAngleBracket();
+
         xml.halfOpenElement(getElementName());
         xml.attribute("jid", jid);
         xml.optAttribute("node", getNode());
         xml.optAttribute("subid", id);
+
         xml.closeEmptyElement();
-        return xml;
+        xml.closeElement(this);
     }
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java

@@ -132,14 +132,11 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
     }
 
     @Override
-    public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder xml = getCommonXml();
+        xml.optAttribute("id", getId());
-
         xml.rightAngleBracket();
-        xml.append(payload.toXML());
+        xml.append(payload);
         xml.closeElement(this);
-
-        return xml;
     }
 
     @Override

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishItem.java

@@ -19,6 +19,8 @@ package org.jivesoftware.smackx.pubsub;
 import java.util.ArrayList;
 import java.util.Collection;
 
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
 /**
  * Represents a request to publish an item(s) to a specific node.
  *
@@ -51,18 +53,9 @@ public class PublishItem<T extends Item> extends NodeExtension {
     }
 
     @Override
-    public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        StringBuilder builder = new StringBuilder("<");
+        xml.rightAngleBracket();
-        builder.append(getElementName());
+        xml.append(items);
-        builder.append(" node='");
+        xml.closeElement(this);
-        builder.append(getNode());
-        builder.append("'>");
-
-        for (Item item : items) {
-            builder.append(item.toXML());
-        }
-        builder.append("</publish>");
-
-        return builder.toString();
     }
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeExtension.java

@@ -16,7 +16,6 @@
  */
 package org.jivesoftware.smackx.pubsub;
 
-import org.jivesoftware.smack.packet.XmlEnvironment;
 import org.jivesoftware.smack.util.XmlStringBuilder;
 
 import org.jxmpp.jid.Jid;
@@ -44,11 +43,8 @@ public class SubscribeExtension extends NodeExtension {
     }
 
     @Override
-    public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder xml = new XmlStringBuilder(this, xmlEnvironment);
-        xml.optAttribute("node", getNode());
         xml.attribute("jid", getJid());
         xml.closeEmptyElement();
-        return xml;
     }
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java

@@ -138,16 +138,11 @@ public class Subscription extends NodeExtension {
     }
 
     @Override
-    public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder builder = new XmlStringBuilder(this);
+        xml.attribute("jid", jid);
-        builder.attribute("jid", jid);
+        xml.optAttribute("subid", id);
-
+        xml.optAttribute("subscription", state);
-        builder.optAttribute("node", getNode());
+        xml.closeEmptyElement();
-        builder.optAttribute("subid", id);
-        builder.optAttribute("subscription", state.toString());
-
-        builder.closeEmptyElement();
-        return builder;
     }
 
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java

@@ -19,6 +19,8 @@ package org.jivesoftware.smackx.pubsub;
 import java.util.Collections;
 import java.util.List;
 
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
 /**
  * Represents the element holding the list of subscription elements.
  *
@@ -91,29 +93,13 @@ public class SubscriptionsExtension extends NodeExtension {
     }
 
     @Override
-    public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
         if ((items == null) || (items.size() == 0)) {
-            return super.toXML(enclosingNamespace);
+            xml.closeEmptyElement();
-        }
+            return;
-        else {
-            StringBuilder builder = new StringBuilder("<");
-            builder.append(getElementName());
-
-            if (getNode() != null) {
-                builder.append(" node='");
-                builder.append(getNode());
-                builder.append('\'');
-            }
-            builder.append('>');
-
-            for (Subscription item : items) {
-                builder.append(item.toXML());
-            }
-
-            builder.append("</");
-            builder.append(getElementName());
-            builder.append('>');
-            return builder.toString();
         }
+        xml.rightAngleBracket();
+        xml.append(items);
+        xml.closeElement(this);
     }
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/UnsubscribeExtension.java

@@ -51,13 +51,9 @@ public class UnsubscribeExtension extends NodeExtension {
     }
 
     @Override
-    public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
+    protected void addXml(XmlStringBuilder xml) {
-        XmlStringBuilder xml = new XmlStringBuilder();
-        xml.halfOpenElement(getElementName());
         xml.attribute("jid", jid);
-        xml.optAttribute("node", getNode());
         xml.optAttribute("subid", id);
         xml.closeEmptyElement();
-        return xml;
     }
 }

smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/AffiliationsExtensionTest.java

@@ -1,6 +1,6 @@
 /**
  *
- * Copyright 2017 Florian Schmaus
+ * Copyright 2017-2020 Florian Schmaus
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 import org.jivesoftware.smackx.pubsub.Affiliation.Type;
+import org.jivesoftware.smackx.pubsub.packet.PubSub;
 
 import org.junit.jupiter.api.Test;
 import org.jxmpp.jid.BareJid;
@@ -40,10 +41,10 @@ public class AffiliationsExtensionTest {
 
         AffiliationsExtension affiliationsExtension = new AffiliationsExtension(affiliationsList, "testNode");
 
-        CharSequence xml = affiliationsExtension.toXML();
+        CharSequence xml = affiliationsExtension.toXML(PubSub.NAMESPACE);
 
         assertXmlSimilar("<affiliations node='testNode'><affiliation xmlns='http://jabber.org/protocol/pubsub#owner' jid='one@exampleone.org' affiliation='member'/></affiliations>",
-                        xml.toString());
+                        xml);
     }
 
 }