uk.ac.ed.epcc.webapp.content

Interface SimpleXMLBuilder

All Known Subinterfaces:

ExtendedXMLBuilder, XMLContentBuilder

All Known Implementing Classes:

AbstractXMLBuilder, HtmlBuilder, HtmlBuilder.Heading, HtmlBuilder.Panel, HtmlBuilder.SpanText, HtmlBuilder.Text, HtmlPrinter, HtmlWriter, JsonBuilder, NestedXMLBuilder, PropertyBuilder, SwingContentBuilder.XMLPanel, TextContentBuilder, XMLDomBuilder, XMLPrinter, XMLWriter

public interface SimpleXMLBuilder

Interface for classes that build XML This interface could either be used to build a DOM tree or perform simple text formatting. It should be more straight-forward to use than DOM but it does require the document to be built in a linear fashion. Elements are added in order and attributes must be added before element content.

Method Summary

Modifier and Type	Method and Description
default <X> void	addObject(X target) Add an object depending on its type.
SimpleXMLBuilder	appendParent() Append the contents of this builder to the parent (if any).
default SimpleXMLBuilder	attr(java.util.Map<java.lang.String,java.lang.String> attr)
SimpleXMLBuilder	attr(java.lang.String name, java.lang.CharSequence s) Add an attribute.
SimpleXMLBuilder	clean(char c)
SimpleXMLBuilder	clean(java.lang.CharSequence s) append text to the document escaping any characters that might be interpreted as XML markup.
SimpleXMLBuilder	clean(java.lang.Number i) Append text representation of the number
SimpleXMLBuilder	close() close the last opened tag.
SimpleXMLBuilder	getNested() Get a new SimpleXMLBuilder of the same type as this object.
SimpleXMLBuilder	getParent() Get the parent object.
SimpleXMLBuilder	open(java.lang.String tag) open a tag
SimpleXMLBuilder	open(java.lang.String tag, java.lang.String[][] attr) open a tag with attributes.
boolean	setEscapeUnicode(boolean escape_unicode) Should high code-point unicode characters be escaped to avoid charset problems.

Method Detail

clean

SimpleXMLBuilder clean(java.lang.CharSequence s)

append text to the document escaping any characters that might be interpreted as XML markup.

Parameters:

s -

Returns:

reference to self.

clean

SimpleXMLBuilder clean(char c)

clean

SimpleXMLBuilder clean(java.lang.Number i)

Append text representation of the number

Parameters:

i - Number to format

Returns:

reference to self

open

SimpleXMLBuilder open(java.lang.String tag)

open a tag

Parameters:

tag -

Returns:

reference to self

open

SimpleXMLBuilder open(java.lang.String tag,
                      java.lang.String[][] attr)

open a tag with attributes. attribute values are escaped

Parameters:

tag - tag to open

attr - array of name,value pairs

Returns:

reference to self

attr

SimpleXMLBuilder attr(java.lang.String name,
                      java.lang.CharSequence s)

Add an attribute. It is only legal to call this after a call to open and before close or clean.

Parameters:

name - String attribute name

s - CharSequence attribute value or null for no value

Returns:

reference to self

attr

default SimpleXMLBuilder attr(java.util.Map<java.lang.String,java.lang.String> attr)

close

SimpleXMLBuilder close()

close the last opened tag.

Returns:

reference to self

getNested

SimpleXMLBuilder getNested()
                    throws java.lang.UnsupportedOperationException

Get a new SimpleXMLBuilder of the same type as this object. This is to build un-commited content that is appended to this object using the appendParent() method. The calling code need only hold a reference to the current builder as the appendParent() method returns the parent.

Returns:

SimpleXMLBuilder

Throws:

java.lang.UnsupportedOperationException

appendParent

SimpleXMLBuilder appendParent()
                       throws java.lang.UnsupportedOperationException

Append the contents of this builder to the parent (if any).

Returns:

the parent

Throws:

java.lang.UnsupportedOperationException

getParent

SimpleXMLBuilder getParent()

Get the parent object.

Returns:

parent

setEscapeUnicode

boolean setEscapeUnicode(boolean escape_unicode)

Should high code-point unicode characters be escaped to avoid charset problems. This is advisory only the implementation is free to ignore this call and return false in all cases.

Parameters:

escape_unicode -

Returns:

previous setting.

addObject

default <X> void addObject(X target)

Add an object depending on its type. This should always map to #addParent() on child objects.

Parameters:

target -