XmlStringBuilder.java

  1. /**
  2.  *
  3.  * Copyright 2014 Florian Schmaus
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smack.util;

  19. import java.util.Collection;

  21. import org.jivesoftware.smack.packet.Element;
  22. import org.jivesoftware.smack.packet.NamedElement;
  23. import org.jivesoftware.smack.packet.ExtensionElement;

  25. public class XmlStringBuilder implements Appendable, CharSequence {
  26.     public static final String RIGHT_ANGLE_BRACKET = Character.toString('>');

  28.     private final LazyStringBuilder sb;

  30.     public XmlStringBuilder() {
  31.         sb = new LazyStringBuilder();
  32.     }

  34.     public XmlStringBuilder(ExtensionElement pe) {
  35.         this();
  36.         prelude(pe);
  37.     }

  39.     public XmlStringBuilder(NamedElement e) {
  40.         this();
  41.         halfOpenElement(e.getElementName());
  42.     }

  44.     public XmlStringBuilder escapedElement(String name, String escapedContent) {
  45.         assert escapedContent != null;
  46.         openElement(name);
  47.         append(escapedContent);
  48.         closeElement(name);
  49.         return this;
  50.     }

  52.     /**
  53.      *
  54.      * @param name
  55.      * @param content
  56.      * @return the XmlStringBuilder
  57.      */
  58.     public XmlStringBuilder element(String name, String content) {
  59.         assert content != null;
  60.         openElement(name);
  61.         escape(content);
  62.         closeElement(name);
  63.         return this;
  64.     }

  66.     /**
  67.     *
  68.     * @param name
  69.     * @param content
  70.     * @return the XmlStringBuilder
  71.     */
  72.    public XmlStringBuilder element(String name, CharSequence content) {
  73.        return element(name, content.toString());
  74.    }

  76.     public XmlStringBuilder element(String name, Enum<?> content) {
  77.         assert content != null;
  78.         element(name, content.name());
  79.         return this;
  80.     }

  82.     public XmlStringBuilder element(Element element) {
  83.         assert element != null;
  84.         return append(element.toXML());
  85.     }

  87.     public XmlStringBuilder optElement(String name, String content) {
  88.         if (content != null) {
  89.             element(name, content);
  90.         }
  91.         return this;
  92.     }

  94.     public XmlStringBuilder optElement(String name, CharSequence content) {
  95.         if (content != null) {
  96.             element(name, content.toString());
  97.         }
  98.         return this;
  99.     }

  101.     public XmlStringBuilder optElement(Element element) {
  102.         if (element != null) {
  103.             append(element.toXML());
  104.         }
  105.         return this;
  106.     }

  108.     public XmlStringBuilder optElement(String name, Enum<?> content) {
  109.         if (content != null) {
  110.             element(name, content);
  111.         }
  112.         return this;
  113.     }

  115.     public XmlStringBuilder optIntElement(String name, int value) {
  116.         if (value >= 0) {
  117.             element(name, String.valueOf(value));
  118.         }
  119.         return this;
  120.     }

  122.     public XmlStringBuilder halfOpenElement(String name) {
  123.         assert(StringUtils.isNotEmpty(name));
  124.         sb.append('<').append(name);
  125.         return this;
  126.     }

  128.     public XmlStringBuilder halfOpenElement(NamedElement namedElement) {
  129.         return halfOpenElement(namedElement.getElementName());
  130.     }

  132.     public XmlStringBuilder openElement(String name) {
  133.         halfOpenElement(name).rightAngleBracket();
  134.         return this;
  135.     }

  137.     public XmlStringBuilder closeElement(String name) {
  138.         sb.append("</").append(name);
  139.         rightAngleBracket();
  140.         return this;
  141.     }

  143.     public XmlStringBuilder closeElement(NamedElement e) {
  144.         closeElement(e.getElementName());
  145.         return this;
  146.     }

  148.     public XmlStringBuilder closeEmptyElement() {
  149.         sb.append("/>");
  150.         return this;
  151.     }

  153.     /**
  154.      * Add a right angle bracket '>'
  155.      * 
  156.      * @return a reference to this object.
  157.      */
  158.     public XmlStringBuilder rightAngleBracket() {
  159.         sb.append(RIGHT_ANGLE_BRACKET);
  160.         return this;
  161.     }

  163.     /**
  164.      * 
  165.      * @return a reference to this object
  166.      * @deprecated use {@link #rightAngleBracket()} instead
  167.      */
  168.     @Deprecated
  169.     public XmlStringBuilder rightAngelBracket() {
  170.         return rightAngleBracket();
  171.     }

  173.     /**
  174.      * Does nothing if value is null.
  175.      *
  176.      * @param name
  177.      * @param value
  178.      * @return the XmlStringBuilder
  179.      */
  180.     public XmlStringBuilder attribute(String name, String value) {
  181.         assert value != null;
  182.         sb.append(' ').append(name).append("='");
  183.         escape(value);
  184.         sb.append('\'');
  185.         return this;
  186.     }

  188.     public XmlStringBuilder attribute(String name, CharSequence value) {
  189.         return attribute(name, value.toString());
  190.     }

  192.     public XmlStringBuilder attribute(String name, Enum<?> value) {
  193.         assert value != null;
  194.         attribute(name, value.name());
  195.         return this;
  196.     }

  198.     public XmlStringBuilder attribute(String name, int value) {
  199.         assert name != null;
  200.         return attribute(name, String.valueOf(value));
  201.     }

  203.     public XmlStringBuilder optAttribute(String name, String value) {
  204.         if (value != null) {
  205.             attribute(name, value);
  206.         }
  207.         return this;
  208.     }

  210.     public XmlStringBuilder optAttribute(String name, CharSequence value) {
  211.         if (value != null) {
  212.             attribute(name, value.toString());
  213.         }
  214.         return this;
  215.     }

  217.     public XmlStringBuilder optAttribute(String name, Enum<?> value) {
  218.         if (value != null) {
  219.             attribute(name, value.toString());
  220.         }
  221.         return this;
  222.     }

  224.     /**
  225.      * Add the given attribute if value => 0
  226.      *
  227.      * @param name
  228.      * @param value
  229.      * @return a reference to this object
  230.      */
  231.     public XmlStringBuilder optIntAttribute(String name, int value) {
  232.         if (value >= 0) {
  233.             attribute(name, Integer.toString(value));
  234.         }
  235.         return this;
  236.     }

  238.     /**
  239.      * Add the given attribute if value not null and value => 0.
  240.      *
  241.      * @param name
  242.      * @param value
  243.      * @return a reference to this object
  244.      */
  245.     public XmlStringBuilder optLongAttribute(String name, Long value) {
  246.         if (value != null && value >= 0) {
  247.             attribute(name, Long.toString(value));
  248.         }
  249.         return this;
  250.     }

  252.     public XmlStringBuilder optBooleanAttribute(String name, boolean bool) {
  253.         if (bool) {
  254.             sb.append(' ').append(name).append("='true'");
  255.         }
  256.         return this;
  257.     }

  259.     public XmlStringBuilder xmlnsAttribute(String value) {
  260.         optAttribute("xmlns", value);
  261.         return this;
  262.     }

  264.     public XmlStringBuilder xmllangAttribute(String value) {
  265.         optAttribute("xml:lang", value);
  266.         return this;
  267.     }
  268.  
  269.     public XmlStringBuilder escape(String text) {
  270.         assert text != null;
  271.         sb.append(StringUtils.escapeForXML(text));
  272.         return this;
  273.     }

  275.     public XmlStringBuilder escape(CharSequence text) {
  276.         return escape(text.toString());
  277.     }

  279.     public XmlStringBuilder prelude(ExtensionElement pe) {
  280.         return prelude(pe.getElementName(), pe.getNamespace());
  281.     }

  283.     public XmlStringBuilder prelude(String elementName, String namespace) {
  284.         halfOpenElement(elementName);
  285.         xmlnsAttribute(namespace);
  286.         return this;
  287.     }

  289.     public XmlStringBuilder optAppend(CharSequence csq) {
  290.         if (csq != null) {
  291.             append(csq);
  292.         }
  293.         return this;
  294.     }

  296.     public XmlStringBuilder optAppend(Element element) {
  297.         if (element != null) {
  298.             append(element.toXML());
  299.         }
  300.         return this;
  301.     }

  303.     public XmlStringBuilder append(XmlStringBuilder xsb) {
  304.         assert xsb != null;
  305.         sb.append(xsb.sb);
  306.         return this;
  307.     }

  309.     public XmlStringBuilder append(Collection<? extends Element> elements) {
  310.         for (Element element : elements) {
  311.             append(element.toXML());
  312.         }
  313.         return this;
  314.     }

  316.     public XmlStringBuilder emptyElement(Enum<?> element) {
  317.         return emptyElement(element.name());
  318.     }

  320.     public XmlStringBuilder emptyElement(String element) {
  321.         halfOpenElement(element);
  322.         return closeEmptyElement();
  323.     }

  325.     public XmlStringBuilder condEmptyElement(boolean condition, String element) {
  326.         if (condition) {
  327.             emptyElement(element);
  328.         }
  329.         return this;
  330.     }

  332.     public XmlStringBuilder condAttribute(boolean condition, String name, String value) {
  333.         if (condition) {
  334.             attribute(name, value);
  335.         }
  336.         return this;
  337.     }

  339.     @Override
  340.     public XmlStringBuilder append(CharSequence csq) {
  341.         assert csq != null;
  342.         sb.append(csq);
  343.         return this;
  344.     }

  346.     @Override
  347.     public XmlStringBuilder append(CharSequence csq, int start, int end) {
  348.         assert csq != null;
  349.         sb.append(csq, start, end);
  350.         return this;
  351.     }

  353.     @Override
  354.     public XmlStringBuilder append(char c) {
  355.         sb.append(c);
  356.         return this;
  357.     }

  359.     @Override
  360.     public int length() {
  361.         return sb.length();
  362.     }

  364.     @Override
  365.     public char charAt(int index) {
  366.         return sb.charAt(index);
  367.     }

  369.     @Override
  370.     public CharSequence subSequence(int start, int end) {
  371.         return sb.subSequence(start, end);
  372.     }

  374.     @Override
  375.     public String toString() {
  376.         return sb.toString();
  377.     }

  379.     @Override
  380.     public boolean equals(Object other) {
  381.         if (!(other instanceof CharSequence)) {
  382.             return false;
  383.         }
  384.         CharSequence otherCharSequenceBuilder = (CharSequence) other;
  385.         return toString().equals(otherCharSequenceBuilder.toString());
  386.     }

  388.     @Override
  389.     public int hashCode() {
  390.         return toString().hashCode();
  391.     }
  392. }
Created with JaCoCo 0.7.4.201502262128