org.codehaus.plexus.util.xml.pull

Class MXSerializer

public class MXSerializer extends Object implements XmlSerializer

Implementation of XmlSerializer interface from XmlPull V1 API. This implementation is optimzied for performance and low memory footprint.

Implemented features:

FEATURE_NAMES_INTERNED - when enabled all returned names (namespaces, prefixes) will be interned and it is required that all names passed as arguments MUST be interned
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE

Implemented properties:

PROPERTY_SERIALIZER_INDENTATION
PROPERTY_SERIALIZER_LINE_SEPARATOR

Field Summary
protected boolean	attributeUseApostrophe
protected int	autoDeclaredPrefixes
protected char[]	buf
static int	BUF_LEN
boolean	checkNamesInterned
protected int	depth
protected boolean	doIndent
protected String[]	elName
protected String[]	elNamespace
protected int[]	elNamespaceCount
protected boolean	finished
protected String	FEATURE_NAMES_INTERNED
protected String	FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected char[]	indentationBuf
protected int	indentationJump
protected String	indentationString
protected String	lineSeparator
protected String	location
protected int	maxIndentLevel
protected boolean	namesInterned
protected int	namespaceEnd
protected String[]	namespacePrefix
protected String[]	namespaceUri
protected int	offsetNewLine
protected Writer	out
protected boolean	pastRoot
protected static String[]	precomputedPrefixes
protected static String	PROPERTY_LOCATION
protected String	PROPERTY_SERIALIZER_INDENTATION
protected String	PROPERTY_SERIALIZER_LINE_SEPARATOR
protected boolean	seenBracket
protected boolean	seenBracketBracket
protected boolean	seenTag
protected boolean	setPrefixCalled
protected boolean	startTagIncomplete
static boolean	TRACE_SIZING
protected boolean	writeIndentation
protected boolean	writeLineSepartor
protected static String	XMLNS_URI
protected static String	XML_URI

Method Summary
static void	addPrintable(StringBuffer retval, char ch)
XmlSerializer	attribute(String namespace, String name, String value)
void	cdsect(String text)
void	checkInterning(String name)
protected void	closeStartTag()
void	comment(String text)
void	docdecl(String text)
void	endDocument()
XmlSerializer	endTag(String namespace, String name)
protected void	ensureElementsCapacity()
protected void	ensureNamespacesCapacity()
void	entityRef(String text)
void	flush()
String	generatePrefix(String namespace)
int	getDepth()
boolean	getFeature(String name)
String	getLocation()
String	getName()
String	getNamespace()
String	getPrefix(String namespace, boolean generatePrefix)
Object	getProperty(String name)
Writer	getWriter()
void	ignorableWhitespace(String text)
protected String	lookupOrDeclarePrefix(String namespace)
protected static String	printable(String s) simple utility method -- good for debugging
protected static String	printable(char ch)
void	processingInstruction(String text)
protected void	rebuildIndentationBuf() For maximum efficiency when writing indents the required output is pre-computed This is internal function that recomputes buffer after user requested chnages.
protected void	reset()
void	setFeature(String name, boolean state)
void	setOutput(Writer writer)
void	setOutput(OutputStream os, String encoding)
void	setPrefix(String prefix, String namespace)
void	setProperty(String name, Object value)
void	startDocument(String encoding, Boolean standalone)
XmlSerializer	startTag(String namespace, String name)
XmlSerializer	text(String text)
XmlSerializer	text(char[] buf, int start, int len)
protected void	writeAttributeValue(String value, Writer out)
protected void	writeElementContent(String text, Writer out)
protected void	writeElementContent(char[] buf, int off, int len, Writer out)
protected void	writeIndent()
void	writeNamespaceDeclarations()

Field Detail

attributeUseApostrophe

protected boolean attributeUseApostrophe

autoDeclaredPrefixes

protected int autoDeclaredPrefixes

buf

protected char[] buf

BUF_LEN

private static final int BUF_LEN

checkNamesInterned

private boolean checkNamesInterned

depth

protected int depth

doIndent

protected boolean doIndent

elName

protected String[] elName

elNamespace

protected String[] elNamespace

elNamespaceCount

protected int[] elNamespaceCount

finished

protected boolean finished

FEATURE_NAMES_INTERNED

protected final String FEATURE_NAMES_INTERNED

FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE

protected final String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE

indentationBuf

protected char[] indentationBuf

indentationJump

protected int indentationJump

indentationString

protected String indentationString

lineSeparator

protected String lineSeparator

location

protected String location

maxIndentLevel

protected int maxIndentLevel

namesInterned

protected boolean namesInterned

namespaceEnd

protected int namespaceEnd

namespacePrefix

protected String[] namespacePrefix

namespaceUri

protected String[] namespaceUri

offsetNewLine

protected int offsetNewLine

out

protected Writer out

pastRoot

protected boolean pastRoot

precomputedPrefixes

protected static final String[] precomputedPrefixes

PROPERTY_LOCATION

protected static final String PROPERTY_LOCATION

PROPERTY_SERIALIZER_INDENTATION

protected final String PROPERTY_SERIALIZER_INDENTATION

PROPERTY_SERIALIZER_LINE_SEPARATOR

protected final String PROPERTY_SERIALIZER_LINE_SEPARATOR

seenBracket

protected boolean seenBracket

seenBracketBracket

protected boolean seenBracketBracket

seenTag

protected boolean seenTag

setPrefixCalled

protected boolean setPrefixCalled

startTagIncomplete

protected boolean startTagIncomplete

TRACE_SIZING

private static final boolean TRACE_SIZING

writeIndentation

protected boolean writeIndentation

writeLineSepartor

protected boolean writeLineSepartor

XMLNS_URI

protected static final String XMLNS_URI

XML_URI

protected static final String XML_URI

Method Detail

addPrintable

private static void addPrintable(StringBuffer retval, char ch)

attribute

public XmlSerializer attribute(String namespace, String name, String value)

cdsect

public void cdsect(String text)

checkInterning

private void checkInterning(String name)

closeStartTag

protected void closeStartTag()

comment

public void comment(String text)

docdecl

public void docdecl(String text)

endDocument

public void endDocument()

endTag

public XmlSerializer endTag(String namespace, String name)

ensureElementsCapacity

protected void ensureElementsCapacity()

ensureNamespacesCapacity

protected void ensureNamespacesCapacity()

entityRef

public void entityRef(String text)

flush

public void flush()

generatePrefix

private String generatePrefix(String namespace)

getDepth

public int getDepth()

getFeature

public boolean getFeature(String name)

getLocation

private String getLocation()

getName

public String getName()

getNamespace

public String getNamespace()

getPrefix

public String getPrefix(String namespace, boolean generatePrefix)

getProperty

public Object getProperty(String name)

getWriter

public Writer getWriter()

ignorableWhitespace

public void ignorableWhitespace(String text)

lookupOrDeclarePrefix

protected String lookupOrDeclarePrefix(String namespace)

printable

protected static final String printable(String s)

simple utility method -- good for debugging

printable

protected static final String printable(char ch)

processingInstruction

public void processingInstruction(String text)

rebuildIndentationBuf

protected void rebuildIndentationBuf()

For maximum efficiency when writing indents the required output is pre-computed This is internal function that recomputes buffer after user requested chnages.