uk.ac.ed.epcc.webapp.content

Class AbstractXMLBuilder

java.lang.Object

uk.ac.ed.epcc.webapp.content.AbstractXMLBuilder

All Implemented Interfaces:

ExtendedXMLBuilder, SimpleXMLBuilder

Direct Known Subclasses:

XMLPrinter, XMLWriter

public abstract class AbstractXMLBuilder
extends java.lang.Object
implements ExtendedXMLBuilder

Base class for creating SimpleXMLBuilder implementations. This class tracks the sax type elements of the SimpleXMLBuilder to accumulate the attributes.

Constructor Summary

Constructors

Constructor and Description
AbstractXMLBuilder()

Method Summary

Modifier and Type	Method and Description
SimpleXMLBuilder	addClass(java.lang.CharSequence s) Convenience method to add an additional class attribute using the HTML convention that multiple classes are represented as one attribute with values separated by spaces.
protected abstract void	append(char s) append un-cleaned content.
protected abstract void	append(java.lang.CharSequence s) append un-cleaned content.
void	append(XMLPrinter hb)
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.
protected void	badAttribute(java.lang.String name)
void	br() Insert line break.
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
boolean	cleanFormatted(int max, java.lang.String s)
void	clear() reset back to starting state
SimpleXMLBuilder	close() close the last opened tag.
protected void	closeElement(java.lang.String tag) action called when element is closed.
protected void	doClean(char c)
protected void	doClean(java.lang.CharSequence s)
protected void	endOpen() Indicates that all attributes have been seen.
protected java.lang.CharSequence	getAttribute(java.lang.String name)
boolean	getEscapeUnicode()
protected java.util.Stack<java.lang.String>	getTags()
boolean	getValidXML()
protected boolean	isInOpen()
boolean	longLines(int max, java.lang.String s) Convert a string into a html fragment with matching linebreaks also comparing the line lengths with a maximum value
boolean	matched() Are all tags matched in the current context.
void	nbs() Insert a non-breaking space.
SimpleXMLBuilder	open(java.lang.String tag) open a tag
SimpleXMLBuilder	open(java.lang.String tag, java.lang.String[][] attr) open a tag with attributes.
void	openElement(java.lang.String tag, java.util.Map<java.lang.String,java.lang.CharSequence> attr, boolean empty) action called for open element
boolean	setEscapeUnicode(boolean escape_unicode) Should high code-point unicode characters be escaped to avoid charset problems.
boolean	setValidXML(boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.content.SimpleXMLBuilder

addObject, appendParent, getNested, getParent

Constructor Detail

AbstractXMLBuilder

public AbstractXMLBuilder()

Method Detail

clean

public final SimpleXMLBuilder clean(char c)

Specified by:

clean in interface SimpleXMLBuilder

clean

public final SimpleXMLBuilder clean(java.lang.CharSequence s)

Description copied from interface: SimpleXMLBuilder

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

Specified by:

clean in interface SimpleXMLBuilder

Returns:

reference to self.

clean

public SimpleXMLBuilder clean(java.lang.Number i)

Description copied from interface: SimpleXMLBuilder

Append text representation of the number

Specified by:

clean in interface SimpleXMLBuilder

Parameters:

i - Number to format

Returns:

reference to self

close

public final SimpleXMLBuilder close()

Description copied from interface: SimpleXMLBuilder

close the last opened tag.

Specified by:

close in interface SimpleXMLBuilder

Returns:

reference to self

openElement

public final void openElement(java.lang.String tag,
                              java.util.Map<java.lang.String,java.lang.CharSequence> attr,
                              boolean empty)

action called for open element

Parameters:

tag - element name

attr - map of attributes or null

empty - is this an empty element (closeElement will not be called).

closeElement

protected void closeElement(java.lang.String tag)

action called when element is closed.

Parameters:

tag -

doClean

protected final void doClean(char c)

append

protected abstract void append(java.lang.CharSequence s)

append un-cleaned content.

Parameters:

s -

append

protected abstract void append(char s)

append un-cleaned content.

Parameters:

s -

doClean

protected final void doClean(java.lang.CharSequence s)

getTags

protected java.util.Stack<java.lang.String> getTags()

endOpen

protected final void endOpen()

Indicates that all attributes have been seen.

isInOpen

protected final boolean isInOpen()

matched

public final boolean matched()

Are all tags matched in the current context.

Returns:

are all tags matched

open

public final SimpleXMLBuilder open(java.lang.String tag)

Description copied from interface: SimpleXMLBuilder

open a tag

Specified by:

open in interface SimpleXMLBuilder

Returns:

reference to self

open

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

Description copied from interface: SimpleXMLBuilder

open a tag with attributes. attribute values are escaped

Specified by:

open in interface SimpleXMLBuilder

Parameters:

tag - tag to open

attr - array of name,value pairs

Returns:

reference to self

attr

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

Specified by:

attr in interface SimpleXMLBuilder

badAttribute

protected void badAttribute(java.lang.String name)

attr

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

Description copied from interface: SimpleXMLBuilder

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

Specified by:

attr in interface SimpleXMLBuilder

Parameters:

name - String attribute name

s - CharSequence attribute value or null for no value

Returns:

reference to self

getAttribute

protected java.lang.CharSequence getAttribute(java.lang.String name)

clear

public void clear()

reset back to starting state

setEscapeUnicode

public boolean setEscapeUnicode(boolean escape_unicode)

Description copied from interface: SimpleXMLBuilder

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.

Specified by:

setEscapeUnicode in interface SimpleXMLBuilder

Returns:

previous setting.

getEscapeUnicode

public boolean getEscapeUnicode()

setValidXML

public boolean setValidXML(boolean value)

getValidXML

public boolean getValidXML()

addClass

public SimpleXMLBuilder addClass(java.lang.CharSequence s)

Description copied from interface: ExtendedXMLBuilder

Convenience method to add an additional class attribute using the HTML convention that multiple classes are represented as one attribute with values separated by spaces. It is only legal to call this after a call to open and before close or clean.

Specified by:

addClass in interface ExtendedXMLBuilder

Parameters:

s - CharSequence attribute value or null for no value

Returns:

reference to self

nbs

public final void nbs()

Description copied from interface: ExtendedXMLBuilder

Insert a non-breaking space.

Specified by:

nbs in interface ExtendedXMLBuilder

longLines

public final boolean longLines(int max,
                               java.lang.String s)

Convert a string into a html fragment with matching linebreaks also comparing the line lengths with a maximum value

Parameters:

max -

s -

Returns:

true if lines are long

cleanFormatted

public final boolean cleanFormatted(int max,
                                    java.lang.String s)

br

public void br()

Description copied from interface: ExtendedXMLBuilder

Insert line break.

Specified by:

br in interface ExtendedXMLBuilder

append

public final void append(XMLPrinter hb)