org.codehaus.plexus.util.xml.pull
Class MXSerializer

java.lang.Object
  org.codehaus.plexus.util.xml.pull.MXSerializer

All Implemented Interfaces:

XmlSerializer

Deprecated.

@Deprecated
public class MXSerializer
extends Object
implements XmlSerializer

Implementation of XmlSerializer interface from XmlPull V1 API. This implementation is optimized 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 Deprecated.
protected int	autoDeclaredPrefixes Deprecated.
protected char[]	buf Deprecated.
protected int	depth Deprecated.
protected boolean	doIndent Deprecated.
protected String[]	elName Deprecated.
protected String[]	elNamespace Deprecated.
protected int[]	elNamespaceCount Deprecated.
protected String	FEATURE_NAMES_INTERNED Deprecated.
protected String	FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE Deprecated.
protected boolean	finished Deprecated.
protected char[]	indentationBuf Deprecated.
protected int	indentationJump Deprecated.
protected String	indentationString Deprecated.
protected String	lineSeparator Deprecated.
protected String	location Deprecated.
protected int	maxIndentLevel Deprecated.
protected boolean	namesInterned Deprecated.
protected int	namespaceEnd Deprecated.
protected String[]	namespacePrefix Deprecated.
protected String[]	namespaceUri Deprecated.
protected int	offsetNewLine Deprecated.
protected Writer	out Deprecated.
protected boolean	pastRoot Deprecated.
protected static String[]	precomputedPrefixes Deprecated.
protected static String	PROPERTY_LOCATION Deprecated.
protected String	PROPERTY_SERIALIZER_INDENTATION Deprecated.
protected String	PROPERTY_SERIALIZER_LINE_SEPARATOR Deprecated.
protected boolean	seenBracket Deprecated.
protected boolean	seenBracketBracket Deprecated.
protected boolean	seenTag Deprecated.
protected boolean	setPrefixCalled Deprecated.
protected boolean	startTagIncomplete Deprecated.
protected boolean	writeIndentation Deprecated.
protected boolean	writeLineSepartor Deprecated.
protected static String	XML_URI Deprecated.
protected static String	XMLNS_URI Deprecated.

Constructor Summary

MXSerializer()
Deprecated.

Method Summary

XmlSerializer	attribute(String namespace, String name, String value) Deprecated. Write an attribute.
void	cdsect(String text) Deprecated.
protected void	closeStartTag() Deprecated.
void	comment(String text) Deprecated.
void	docdecl(String text) Deprecated.
void	endDocument() Deprecated. Finish writing.
XmlSerializer	endTag(String namespace, String name) Deprecated. Write end tag.
protected void	ensureElementsCapacity() Deprecated.
protected void	ensureNamespacesCapacity() Deprecated.
void	entityRef(String text) Deprecated.
void	flush() Deprecated. Write all pending output to the stream.
int	getDepth() Deprecated. Returns the current depth of the element.
boolean	getFeature(String name) Deprecated. Return the current value of the feature with given name.
String	getName() Deprecated. Returns the name of the current element as set by startTag().
String	getNamespace() Deprecated. Returns the namespace URI of the current element as set by startTag().
String	getPrefix(String namespace, boolean generatePrefix) Deprecated. Return namespace that corresponds to given prefix If there is no prefix bound to this namespace return null but if generatePrefix is false then return generated prefix.
Object	getProperty(String name) Deprecated. Look up the value of a property.
Writer	getWriter() Deprecated.
void	ignorableWhitespace(String text) Deprecated.
protected String	lookupOrDeclarePrefix(String namespace) Deprecated.
protected static String	printable(char ch) Deprecated.
protected static String	printable(String s) Deprecated. simple utility method -- good for debugging
void	processingInstruction(String text) Deprecated.
protected void	rebuildIndentationBuf() Deprecated. 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() Deprecated.
void	setFeature(String name, boolean state) Deprecated. Set feature identified by name (recommended to be URI for uniqueness).
void	setOutput(OutputStream os, String encoding) Deprecated. Set to use binary output stream with given encoding.
void	setOutput(Writer writer) Deprecated. Set the output to the given writer.
void	setPrefix(String prefix, String namespace) Deprecated. Binds the given prefix to the given namespace.
void	setProperty(String name, Object value) Deprecated. Set the value of a property.
void	startDocument(String encoding, Boolean standalone) Deprecated. Write <?xml declaration with encoding (if encoding not null) and standalone flag (if standalone not null) This method can only be called just after setOutput.
XmlSerializer	startTag(String namespace, String name) Deprecated. Writes a start tag with the given namespace and name.
XmlSerializer	text(char[] buf, int start, int len) Deprecated. Writes text, where special XML chars are escaped automatically
XmlSerializer	text(String text) Deprecated. Writes text, where special XML chars are escaped automatically
protected void	writeAttributeValue(String value, Writer out) Deprecated.
protected void	writeElementContent(char[] buf, int off, int len, Writer out) Deprecated.
protected void	writeElementContent(String text, Writer out) Deprecated.
protected void	writeIndent() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

XML_URI

protected static final String XML_URI

Deprecated.

See Also:

Constant Field Values

XMLNS_URI

protected static final String XMLNS_URI

Deprecated.

See Also:

Constant Field Values

FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE

protected final String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE

Deprecated.

See Also:

Constant Field Values

FEATURE_NAMES_INTERNED

protected final String FEATURE_NAMES_INTERNED

Deprecated.

See Also:

Constant Field Values

PROPERTY_SERIALIZER_INDENTATION

protected final String PROPERTY_SERIALIZER_INDENTATION

Deprecated.

See Also:

Constant Field Values

PROPERTY_SERIALIZER_LINE_SEPARATOR

protected final String PROPERTY_SERIALIZER_LINE_SEPARATOR

Deprecated.

See Also:

Constant Field Values

PROPERTY_LOCATION

protected static final String PROPERTY_LOCATION

Deprecated.

See Also:

Constant Field Values

namesInterned

protected boolean namesInterned

Deprecated.

attributeUseApostrophe

protected boolean attributeUseApostrophe

Deprecated.

indentationString

protected String indentationString

Deprecated.

lineSeparator

protected String lineSeparator

Deprecated.

location

protected String location

Deprecated.

out

protected Writer out

Deprecated.

autoDeclaredPrefixes

protected int autoDeclaredPrefixes

Deprecated.

depth

protected int depth

Deprecated.

elNamespace

protected String[] elNamespace

Deprecated.

elName

protected String[] elName

Deprecated.

elNamespaceCount

protected int[] elNamespaceCount

Deprecated.

namespaceEnd

protected int namespaceEnd

Deprecated.

namespacePrefix

protected String[] namespacePrefix

Deprecated.

namespaceUri

protected String[] namespaceUri

Deprecated.

finished

protected boolean finished

Deprecated.

pastRoot

protected boolean pastRoot

Deprecated.

setPrefixCalled

protected boolean setPrefixCalled

Deprecated.

startTagIncomplete

protected boolean startTagIncomplete

Deprecated.

doIndent

protected boolean doIndent

Deprecated.

seenTag

protected boolean seenTag

Deprecated.

seenBracket

protected boolean seenBracket

Deprecated.

seenBracketBracket

protected boolean seenBracketBracket

Deprecated.

buf

protected char[] buf

Deprecated.

precomputedPrefixes

protected static final String[] precomputedPrefixes

Deprecated.

offsetNewLine

protected int offsetNewLine

Deprecated.

indentationJump

protected int indentationJump

Deprecated.

indentationBuf

protected char[] indentationBuf

Deprecated.

maxIndentLevel

protected int maxIndentLevel

Deprecated.

writeLineSepartor

protected boolean writeLineSepartor

Deprecated.

writeIndentation

protected boolean writeIndentation

Deprecated.

Constructor Detail

MXSerializer

public MXSerializer()

Deprecated.

Method Detail

reset

protected void reset()

Deprecated.

ensureElementsCapacity

protected void ensureElementsCapacity()

Deprecated.

ensureNamespacesCapacity

protected void ensureNamespacesCapacity()

Deprecated.

setFeature

public void setFeature(String name,
                       boolean state)
                throws IllegalArgumentException,
                       IllegalStateException

Deprecated.

Description copied from interface: XmlSerializer

Set feature identified by name (recommended to be URI for uniqueness). Some well known optional features are defined in http://www.xmlpull.org/v1/doc/features.html. If feature is not recognized or can not be set then IllegalStateException MUST be thrown.

Specified by:

setFeature in interface XmlSerializer

Throws:

IllegalStateException - If the feature is not supported or can not be set

IllegalArgumentException

getFeature

public boolean getFeature(String name)
                   throws IllegalArgumentException

Deprecated.

Description copied from interface: XmlSerializer

Return the current value of the feature with given name.

NOTE: unknown properties are always returned as null

Specified by:

getFeature in interface XmlSerializer

Parameters:

name - The name of feature to be retrieved.

Returns:

The value of named feature.

Throws:

IllegalArgumentException - if feature string is null

rebuildIndentationBuf

protected void rebuildIndentationBuf()

Deprecated.

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

writeIndent

protected void writeIndent()
                    throws IOException

Deprecated.

Throws:

IOException

setProperty

public void setProperty(String name,
                        Object value)
                 throws IllegalArgumentException,
                        IllegalStateException

Deprecated.

Description copied from interface: XmlSerializer

Set the value of a property. (the property name is recommended to be URI for uniqueness). Some well known optional properties are defined in http://www.xmlpull.org/v1/doc/properties.html. If property is not recognized or can not be set then IllegalStateException MUST be thrown.

Specified by:

setProperty in interface XmlSerializer

Throws:

IllegalStateException - if the property is not supported or can not be set

IllegalArgumentException

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Deprecated.

Description copied from interface: XmlSerializer

Look up the value of a property. The property name is any fully-qualified URI. I

NOTE: unknown properties are always returned as null

Specified by:

getProperty in interface XmlSerializer

Parameters:

name - The name of property to be retrieved.

Returns:

The value of named property.

Throws:

IllegalArgumentException

getWriter

public Writer getWriter()

Deprecated.

setOutput

public void setOutput(Writer writer)

Deprecated.

Description copied from interface: XmlSerializer

Set the output to the given writer.

WARNING no information about encoding is available!

Specified by:

setOutput in interface XmlSerializer

setOutput

public void setOutput(OutputStream os,
                      String encoding)
               throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Set to use binary output stream with given encoding.

Specified by:

setOutput in interface XmlSerializer

Throws:

IOException

startDocument

public void startDocument(String encoding,
                          Boolean standalone)
                   throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Write <?xml declaration with encoding (if encoding not null) and standalone flag (if standalone not null) This method can only be called just after setOutput.

Specified by:

startDocument in interface XmlSerializer

Throws:

IOException

endDocument

public void endDocument()
                 throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Finish writing. All unclosed start tags will be closed and output will be flushed. After calling this method no more output can be serialized until next call to setOutput()

Specified by:

endDocument in interface XmlSerializer

Throws:

IOException

setPrefix

public void setPrefix(String prefix,
                      String namespace)
               throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Binds the given prefix to the given namespace. This call is valid for the next element including child elements. The prefix and namespace MUST be always declared even if prefix is not used in element (startTag() or attribute()) - for XML 1.0 it must result in declaring xmlns:prefix='namespace' (or xmlns:prefix="namespace" depending what character is used to quote attribute value).

NOTE: this method MUST be called directly before startTag() and if anything but startTag() or setPrefix() is called next there will be exception.

NOTE: prefixes "xml" and "xmlns" are already bound and can not be redefined see: Namespaces in XML Errata.

NOTE: to set default namespace use as prefix empty string.

Specified by:

setPrefix in interface XmlSerializer

Parameters:

prefix - must be not null (or IllegalArgumentException is thrown)

namespace - must be not null

Throws:

IOException

lookupOrDeclarePrefix

protected String lookupOrDeclarePrefix(String namespace)

Deprecated.

getPrefix

public String getPrefix(String namespace,
                        boolean generatePrefix)

Deprecated.

Description copied from interface: XmlSerializer

Return namespace that corresponds to given prefix If there is no prefix bound to this namespace return null but if generatePrefix is false then return generated prefix.

NOTE: if the prefix is empty string "" and default namespace is bound to this prefix then empty string ("") is returned.

NOTE: prefixes "xml" and "xmlns" are already bound will have values as defined Namespaces in XML specification

Specified by:

getPrefix in interface XmlSerializer

getDepth

public int getDepth()

Deprecated.

Description copied from interface: XmlSerializer

Returns the current depth of the element. Outside the root element, the depth is 0. The depth is incremented by 1 when startTag() is called. The depth is decremented after the call to endTag() event was observed.

 <!-- outside -->     0
 <root>               1
   sometext                 1
     <foobar>         2
     </foobar>        2
 </root>              1
 <!-- outside -->     0
 

Specified by:

getDepth in interface XmlSerializer

getNamespace

public String getNamespace()

Deprecated.

Description copied from interface: XmlSerializer

Returns the namespace URI of the current element as set by startTag().

NOTE: that means in particular that:

• if there was startTag("", ...) then getNamespace() returns ""
• if there was startTag(null, ...) then getNamespace() returns null

Specified by:

getNamespace in interface XmlSerializer

Returns:

namespace set by startTag() that is currently in scope

getName

public String getName()

Deprecated.

Description copied from interface: XmlSerializer

Returns the name of the current element as set by startTag(). It can only be null before first call to startTag() or when last endTag() is called to close first startTag().

Specified by:

getName in interface XmlSerializer

Returns:

namespace set by startTag() that is currently in scope

startTag

public XmlSerializer startTag(String namespace,
                              String name)
                       throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Writes a start tag with the given namespace and name. If there is no prefix defined for the given namespace, a prefix will be defined automatically. The explicit prefixes for namespaces can be established by calling setPrefix() immediately before this method. If namespace is null no namespace prefix is printed but just name. If namespace is empty string then serializer will make sure that default empty namespace is declared (in XML 1.0 xmlns='') or throw IllegalStateException if default namespace is already bound to non-empty string.

Specified by:

startTag in interface XmlSerializer

Throws:

IOException

attribute

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

Deprecated.

Description copied from interface: XmlSerializer

Write an attribute. Calls to attribute() MUST follow a call to startTag() immediately. If there is no prefix defined for the given namespace, a prefix will be defined automatically. If namespace is null or empty string no namespace prefix is printed but just name.

Specified by:

attribute in interface XmlSerializer

Throws:

IOException

closeStartTag

protected void closeStartTag()
                      throws IOException

Deprecated.

Throws:

IOException

endTag

public XmlSerializer endTag(String namespace,
                            String name)
                     throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Write end tag. Repetition of namespace and name is just for avoiding errors.

Background: in kXML endTag had no arguments, and non matching tags were very difficult to find... If namespace is null no namespace prefix is printed but just name. If namespace is empty string then serializer will make sure that default empty namespace is declared (in XML 1.0 xmlns='').

Specified by:

endTag in interface XmlSerializer

Throws:

IOException

text

public XmlSerializer text(String text)
                   throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Writes text, where special XML chars are escaped automatically

Specified by:

text in interface XmlSerializer

Throws:

IOException

text

public XmlSerializer text(char[] buf,
                          int start,
                          int len)
                   throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Writes text, where special XML chars are escaped automatically

Specified by:

text in interface XmlSerializer

Throws:

IOException

cdsect

public void cdsect(String text)
            throws IOException

Deprecated.

Specified by:

cdsect in interface XmlSerializer

Throws:

IOException

entityRef

public void entityRef(String text)
               throws IOException

Deprecated.

Specified by:

entityRef in interface XmlSerializer

Throws:

IOException

processingInstruction

public void processingInstruction(String text)
                           throws IOException

Deprecated.

Specified by:

processingInstruction in interface XmlSerializer

Throws:

IOException

comment

public void comment(String text)
             throws IOException

Deprecated.

Specified by:

comment in interface XmlSerializer

Throws:

IOException

docdecl

public void docdecl(String text)
             throws IOException

Deprecated.

Specified by:

docdecl in interface XmlSerializer

Throws:

IOException

ignorableWhitespace

public void ignorableWhitespace(String text)
                         throws IOException

Deprecated.

Specified by:

ignorableWhitespace in interface XmlSerializer

Throws:

IOException

flush

public void flush()
           throws IOException

Deprecated.

Description copied from interface: XmlSerializer

Write all pending output to the stream. If method startTag() or attribute() was called then start tag is closed (final >) before flush() is called on underlying output stream.

NOTE: if there is need to close start tag (so no more attribute() calls are allowed) but without flushing output call method text() with empty string (text("")).

Specified by:

flush in interface XmlSerializer

Throws:

IOException

writeAttributeValue

protected void writeAttributeValue(String value,
                                   Writer out)
                            throws IOException

Deprecated.

Throws:

IOException

writeElementContent

protected void writeElementContent(String text,
                                   Writer out)
                            throws IOException

Deprecated.

Throws:

IOException

writeElementContent

protected void writeElementContent(char[] buf,
                                   int off,
                                   int len,
                                   Writer out)
                            throws IOException

Deprecated.

Throws:

IOException

printable

protected static final String printable(String s)

Deprecated.

simple utility method -- good for debugging

printable

protected static final String printable(char ch)

Deprecated.