Package org.jivesoftware.smack.util

Class XmlStringBuilder

java.lang.Object

org.jivesoftware.smack.util.XmlStringBuilder

All Implemented Interfaces:

Appendable, CharSequence, Element

Direct Known Subclasses:

IQ.IQChildElementXmlStringBuilder

public class XmlStringBuilder
extends Object
implements Appendable, CharSequence, Element

Field Summary

Fields

Modifier and Type	Field	Description
static String	RIGHT_ANGLE_BRACKET

Constructor Summary

Constructors

Constructor	Description
XmlStringBuilder()
XmlStringBuilder(String elementName, String xmlNs, String xmlLang, XmlEnvironment enclosingXmlEnvironment)
XmlStringBuilder(NamedElement e)
XmlStringBuilder(XmlElement pe)
XmlStringBuilder(XmlElement element, XmlEnvironment enclosingXmlEnvironment)

Method Summary

Modifier and Type	Method	Description
XmlStringBuilder	append(char c)
XmlStringBuilder	append(CharSequence csq)
XmlStringBuilder	append(CharSequence csq, int start, int end)
XmlStringBuilder	append(Collection<? extends Element> elements)
XmlStringBuilder	append(Element element)
XmlStringBuilder	append(XmlStringBuilder xsb)
XmlStringBuilder	attribute(String name, boolean bool)
XmlStringBuilder	attribute(String name, int value)
XmlStringBuilder	attribute(String name, long value)
<E extends Enum<?>> XmlStringBuilder	attribute(String name, E value, E implicitDefault)
XmlStringBuilder	attribute(String name, CharSequence value)
XmlStringBuilder	attribute(String name, Enum<?> value)
XmlStringBuilder	attribute(String name, String value)	Does nothing if value is null.
XmlStringBuilder	attribute(String name, Date value)	Add a new attribute to this builder, with the Date instance as its value, which will get formatted with XmppDateTime.formatXEP0082Date(Date).
char	charAt(int index)
XmlStringBuilder	closeElement(String name)
XmlStringBuilder	closeElement(NamedElement e)
XmlStringBuilder	closeEmptyElement()
XmlStringBuilder	condAttribute(boolean condition, String name, String value)
XmlStringBuilder	condEmptyElement(boolean condition, String element)
XmlStringBuilder	element(String name, CharSequence content)	Add a new element to this builder.
XmlStringBuilder	element(String name, Enum<?> content)
XmlStringBuilder	element(String name, String content)	Add a new element to this builder.
XmlStringBuilder	element(String name, Date content)	Add a new element to this builder, with the Date instance as its content, which will get formatted with XmppDateTime.formatXEP0082Date(Date).
XmlStringBuilder	element(Element element)	Deprecated. use append(Element) instead.
XmlStringBuilder	emptyElement(Enum<?> element)
XmlStringBuilder	emptyElement(String element)
boolean	equals(Object other)
XmlStringBuilder	escape(CharSequence text)
XmlStringBuilder	escape(String text)
XmlStringBuilder	escapeAttributeValue(String value)
XmlStringBuilder	escapedElement(String name, String escapedContent)
XmlEnvironment	getXmlEnvironment()
XmlStringBuilder	halfOpenElement(String name)
XmlStringBuilder	halfOpenElement(NamedElement namedElement)
int	hashCode()
int	length()
XmlStringBuilder	openElement(String name)
XmlStringBuilder	optAppend(Collection<? extends Element> elements)
XmlStringBuilder	optAppend(Element element)
XmlStringBuilder	optAttribute(String name, CharSequence value)
XmlStringBuilder	optAttribute(String name, Enum<?> value)
XmlStringBuilder	optAttribute(String name, Long value)
XmlStringBuilder	optAttribute(String name, Number number)
XmlStringBuilder	optAttribute(String name, String value)
XmlStringBuilder	optAttribute(String name, Date value)	Add a new attribute to this builder, with the Date instance as its value, which will get formatted with XmppDateTime.formatXEP0082Date(Date) if Date instance is not null.
XmlStringBuilder	optAttributeCs(String name, CharSequence value)	Same as optAttribute(String, CharSequence), but with a different method name.
XmlStringBuilder	optBooleanAttribute(String name, boolean bool)
XmlStringBuilder	optBooleanAttributeDefaultTrue(String name, boolean bool)
XmlStringBuilder	optElement(String name, CharSequence content)
XmlStringBuilder	optElement(String name, Enum<?> content)
XmlStringBuilder	optElement(String name, Object object)
XmlStringBuilder	optElement(String name, String content)
XmlStringBuilder	optElement(String name, Date content)	Add a new element to this builder, with the Date instance as its content, which will get formatted with XmppDateTime.formatXEP0082Date(Date) if Date instance is not null.
XmlStringBuilder	optElement(Element element)
XmlStringBuilder	optEscape(CharSequence text)
XmlStringBuilder	optIntAttribute(String name, int value)	Add the given attribute if value => 0.
XmlStringBuilder	optIntAttribute(String name, Integer value)	If the provided Integer argument is not null, then add a new XML attribute with the given name and the Integer as value.
XmlStringBuilder	optIntElement(String name, int value)
XmlStringBuilder	optLongAttribute(String name, Long value)	Add the given attribute if value not null and value => 0.
XmlStringBuilder	optTextChild(CharSequence sqc, NamedElement parentElement)
XmlStringBuilder	optXmlLangAttribute(String lang)
protected XmlStringBuilder	prelude(String elementName, String namespace)
protected XmlStringBuilder	prelude(XmlElement pe)
XmlStringBuilder	rightAngleBracket()	Add a right angle bracket '>'.
CharSequence	subSequence(int start, int end)
XmlStringBuilder	text(CharSequence text)
List<CharSequence>	toList(XmlEnvironment enclosingXmlEnvironment)
String	toString()
StringBuilder	toXML(XmlEnvironment enclosingXmlEnvironment)
void	write(Writer writer, XmlEnvironment enclosingXmlEnvironment)	Write the contents of this XmlStringBuilder to a Writer.
XmlStringBuilder	xmllangAttribute(String value)
XmlStringBuilder	xmlnsAttribute(String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Field Detail

RIGHT_ANGLE_BRACKET

public static final String RIGHT_ANGLE_BRACKET

Constructor Detail

XmlStringBuilder

public XmlStringBuilder()

XmlStringBuilder

public XmlStringBuilder(XmlElement pe)

XmlStringBuilder

public XmlStringBuilder(NamedElement e)

XmlStringBuilder

public XmlStringBuilder(XmlElement element,
                        XmlEnvironment enclosingXmlEnvironment)

XmlStringBuilder

public XmlStringBuilder(String elementName,
                        String xmlNs,
                        String xmlLang,
                        XmlEnvironment enclosingXmlEnvironment)

Method Detail

getXmlEnvironment

public XmlEnvironment getXmlEnvironment()

escapedElement

public XmlStringBuilder escapedElement(String name,
                                       String escapedContent)

element

public XmlStringBuilder element(String name,
                                String content)

Add a new element to this builder.

Parameters:

name - TODO javadoc me please

content - TODO javadoc me please

Returns:

the XmlStringBuilder

element

public XmlStringBuilder element(String name,
                                Date content)

Add a new element to this builder, with the Date instance as its content, which will get formatted with XmppDateTime.formatXEP0082Date(Date).

Parameters:

name - element name

content - content of element

Returns:

this XmlStringBuilder

element

public XmlStringBuilder element(String name,
                                CharSequence content)

Add a new element to this builder.

Parameters:

name - TODO javadoc me please

content - TODO javadoc me please

Returns:

the XmlStringBuilder

element

public XmlStringBuilder element(String name,
                                Enum<?> content)

element

@Deprecated
public XmlStringBuilder element(Element element)

Deprecated.

use append(Element) instead.

Deprecated.

Parameters:

element - deprecated.

Returns:

deprecated.

optElement

public XmlStringBuilder optElement(String name,
                                   String content)

optElement

public XmlStringBuilder optElement(String name,
                                   Date content)

Add a new element to this builder, with the Date instance as its content, which will get formatted with XmppDateTime.formatXEP0082Date(Date) if Date instance is not null.

Parameters:

name - element name

content - content of element

Returns:

this XmlStringBuilder

optElement

public XmlStringBuilder optElement(String name,
                                   CharSequence content)

optElement

public XmlStringBuilder optElement(Element element)

optElement

public XmlStringBuilder optElement(String name,
                                   Enum<?> content)

optElement

public XmlStringBuilder optElement(String name,
                                   Object object)

optIntElement

public XmlStringBuilder optIntElement(String name,
                                      int value)

halfOpenElement

public XmlStringBuilder halfOpenElement(String name)

halfOpenElement

public XmlStringBuilder halfOpenElement(NamedElement namedElement)

openElement

public XmlStringBuilder openElement(String name)

closeElement

public XmlStringBuilder closeElement(String name)

closeElement

public XmlStringBuilder closeElement(NamedElement e)

closeEmptyElement

public XmlStringBuilder closeEmptyElement()

rightAngleBracket

public XmlStringBuilder rightAngleBracket()

Add a right angle bracket '>'.

Returns:

a reference to this object.

attribute

public XmlStringBuilder attribute(String name,
                                  String value)

Does nothing if value is null.

Parameters:

name - TODO javadoc me please

value - TODO javadoc me please

Returns:

the XmlStringBuilder

attribute

public XmlStringBuilder attribute(String name,
                                  boolean bool)

attribute

public XmlStringBuilder attribute(String name,
                                  Date value)

Add a new attribute to this builder, with the Date instance as its value, which will get formatted with XmppDateTime.formatXEP0082Date(Date).

Parameters:

name - name of attribute

value - value of attribute

Returns:

this XmlStringBuilder

attribute

public XmlStringBuilder attribute(String name,
                                  CharSequence value)

attribute

public XmlStringBuilder attribute(String name,
                                  Enum<?> value)

attribute

public <E extends Enum<?>> XmlStringBuilder attribute(String name,
                                                      E value,
                                                      E implicitDefault)

attribute

public XmlStringBuilder attribute(String name,
                                  int value)

attribute

public XmlStringBuilder attribute(String name,
                                  long value)

optAttribute

public XmlStringBuilder optAttribute(String name,
                                     String value)

optAttribute

public XmlStringBuilder optAttribute(String name,
                                     Long value)

optAttribute

public XmlStringBuilder optAttribute(String name,
                                     Date value)

Add a new attribute to this builder, with the Date instance as its value, which will get formatted with XmppDateTime.formatXEP0082Date(Date) if Date instance is not null.

Parameters:

name - attribute name

value - value of this attribute

Returns:

this XmlStringBuilder

optAttribute

public XmlStringBuilder optAttribute(String name,
                                     CharSequence value)

optAttribute

public XmlStringBuilder optAttribute(String name,
                                     Enum<?> value)

optAttribute

public XmlStringBuilder optAttribute(String name,
                                     Number number)

optAttributeCs

public XmlStringBuilder optAttributeCs(String name,
                                       CharSequence value)

Same as optAttribute(String, CharSequence), but with a different method name. This method can be used if the provided attribute value argument type causes ambiguity in method overloading. For example if the type is a subclass of Number and CharSequence.

Parameters:

name - the name of the attribute.

value - the value of the attribute.

Returns:

a reference to this object.

Since:

4.5

optIntAttribute

public XmlStringBuilder optIntAttribute(String name,
                                        int value)

Add the given attribute if value => 0.

Parameters:

name - TODO javadoc me please

value - TODO javadoc me please

Returns:

a reference to this object

optIntAttribute

public XmlStringBuilder optIntAttribute(String name,
                                        Integer value)

If the provided Integer argument is not null, then add a new XML attribute with the given name and the Integer as value.

Parameters:

name - the XML attribute name.

value - the optional integer to use as the attribute's value.

Returns:

a reference to this object.

Since:

4.4.1

optLongAttribute

public XmlStringBuilder optLongAttribute(String name,
                                         Long value)

Add the given attribute if value not null and value => 0.

Parameters:

name - TODO javadoc me please

value - TODO javadoc me please

Returns:

a reference to this object

optBooleanAttribute

public XmlStringBuilder optBooleanAttribute(String name,
                                            boolean bool)

optBooleanAttributeDefaultTrue

public XmlStringBuilder optBooleanAttributeDefaultTrue(String name,
                                                       boolean bool)

xmlnsAttribute

public XmlStringBuilder xmlnsAttribute(String value)

xmllangAttribute

public XmlStringBuilder xmllangAttribute(String value)

optXmlLangAttribute

public XmlStringBuilder optXmlLangAttribute(String lang)

text

public XmlStringBuilder text(CharSequence text)

escape

public XmlStringBuilder escape(String text)

escapeAttributeValue

public XmlStringBuilder escapeAttributeValue(String value)

optEscape

public XmlStringBuilder optEscape(CharSequence text)

escape

public XmlStringBuilder escape(CharSequence text)

prelude

protected XmlStringBuilder prelude(XmlElement pe)

prelude

protected XmlStringBuilder prelude(String elementName,
                                   String namespace)

optAppend

public XmlStringBuilder optAppend(Element element)

optAppend

public XmlStringBuilder optAppend(Collection<? extends Element> elements)

optTextChild

public XmlStringBuilder optTextChild(CharSequence sqc,
                                     NamedElement parentElement)

append

public XmlStringBuilder append(XmlStringBuilder xsb)

append

public XmlStringBuilder append(Element element)

append

public XmlStringBuilder append(Collection<? extends Element> elements)

emptyElement

public XmlStringBuilder emptyElement(Enum<?> element)

emptyElement

public XmlStringBuilder emptyElement(String element)

condEmptyElement

public XmlStringBuilder condEmptyElement(boolean condition,
                                         String element)

condAttribute

public XmlStringBuilder condAttribute(boolean condition,
                                      String name,
                                      String value)

append

public XmlStringBuilder append(CharSequence csq)

Specified by:

append in interface Appendable

append

public XmlStringBuilder append(CharSequence csq,
                               int start,
                               int end)

Specified by:

append in interface Appendable

append

public XmlStringBuilder append(char c)

Specified by:

append in interface Appendable

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

write

public void write(Writer writer,
                  XmlEnvironment enclosingXmlEnvironment)
           throws IOException

Write the contents of this XmlStringBuilder to a Writer. This will write the single parts one-by-one, avoiding allocation of a big continuous memory block holding the XmlStringBuilder contents.

Parameters:

writer - TODO javadoc me please

enclosingXmlEnvironment - the enclosing XML environment.

Throws:

IOException - if an I/O error occurred.

toList

public List<CharSequence> toList(XmlEnvironment enclosingXmlEnvironment)

toXML

public StringBuilder toXML(XmlEnvironment enclosingXmlEnvironment)

Specified by:

toXML in interface Element