Class MXSerializer
- java.lang.Object
-
- org.codehaus.plexus.util.xml.pull.MXSerializer
-
- All Implemented Interfaces:
XmlSerializer
public class MXSerializer extends java.lang.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
Fields Modifier and Type Field Description protected boolean
attributeUseApostrophe
protected int
autoDeclaredPrefixes
protected char[]
buf
private static int
BUF_LEN
private boolean
checkNamesInterned
protected int
depth
protected boolean
doIndent
protected java.lang.String[]
elName
protected java.lang.String[]
elNamespace
protected int[]
elNamespaceCount
protected java.lang.String
FEATURE_NAMES_INTERNED
protected java.lang.String
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected boolean
finished
protected char[]
indentationBuf
protected int
indentationJump
protected java.lang.String
indentationString
protected java.lang.String
lineSeparator
protected java.lang.String
location
protected int
maxIndentLevel
protected boolean
namesInterned
protected int
namespaceEnd
protected java.lang.String[]
namespacePrefix
protected java.lang.String[]
namespaceUri
protected int
offsetNewLine
protected java.io.Writer
out
protected boolean
pastRoot
protected static java.lang.String[]
precomputedPrefixes
protected static java.lang.String
PROPERTY_LOCATION
protected java.lang.String
PROPERTY_SERIALIZER_INDENTATION
protected java.lang.String
PROPERTY_SERIALIZER_LINE_SEPARATOR
protected boolean
seenBracket
protected boolean
seenBracketBracket
protected boolean
seenTag
protected boolean
setPrefixCalled
protected boolean
startTagIncomplete
private static boolean
TRACE_SIZING
protected boolean
writeIndentation
protected boolean
writeLineSeparator
protected static java.lang.String
XML_URI
protected static java.lang.String
XMLNS_URI
-
Constructor Summary
Constructors Constructor Description MXSerializer()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
addPrintable(java.lang.StringBuilder retval, char ch)
XmlSerializer
attribute(java.lang.String namespace, java.lang.String name, java.lang.String value)
Write an attribute.void
cdsect(java.lang.String text)
private void
checkInterning(java.lang.String name)
protected void
closeStartTag()
void
comment(java.lang.String text)
void
docdecl(java.lang.String text)
void
endDocument()
Finish writing.XmlSerializer
endTag(java.lang.String namespace, java.lang.String name)
Write end tag.protected void
ensureElementsCapacity()
protected void
ensureNamespacesCapacity()
void
entityRef(java.lang.String text)
void
flush()
Write all pending output to the stream.private java.lang.String
generatePrefix(java.lang.String namespace)
int
getDepth()
Returns the current depth of the element.boolean
getFeature(java.lang.String name)
Return the current value of the feature with given name.private java.lang.String
getLocation()
java.lang.String
getName()
Returns the name of the current element as set by startTag().java.lang.String
getNamespace()
Returns the namespace URI of the current element as set by startTag().java.lang.String
getPrefix(java.lang.String namespace, boolean generatePrefix)
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.java.lang.Object
getProperty(java.lang.String name)
Look up the value of a property.java.io.Writer
getWriter()
void
ignorableWhitespace(java.lang.String text)
protected java.lang.String
lookupOrDeclarePrefix(java.lang.String namespace)
protected static java.lang.String
printable(char ch)
protected static java.lang.String
printable(java.lang.String s)
simple utility method -- good for debuggingvoid
processingInstruction(java.lang.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 changes.protected void
reset()
void
setFeature(java.lang.String name, boolean state)
Set feature identified by name (recommended to be URI for uniqueness).void
setOutput(java.io.OutputStream os, java.lang.String encoding)
Set to use binary output stream with given encoding.void
setOutput(java.io.Writer writer)
Set the output to the given writer.void
setPrefix(java.lang.String prefix, java.lang.String namespace)
Binds the given prefix to the given namespace.void
setProperty(java.lang.String name, java.lang.Object value)
Set the value of a property.void
startDocument(java.lang.String encoding, java.lang.Boolean standalone)
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(java.lang.String namespace, java.lang.String name)
Writes a start tag with the given namespace and name.XmlSerializer
text(char[] buf, int start, int len)
Writes text, where special XML chars are escaped automaticallyXmlSerializer
text(java.lang.String text)
Writes text, where special XML chars are escaped automaticallyprotected void
writeAttributeValue(java.lang.String value, java.io.Writer out)
protected void
writeElementContent(char[] buf, int off, int len, java.io.Writer out)
protected void
writeElementContent(java.lang.String text, java.io.Writer out)
protected void
writeIndent()
private void
writeNamespaceDeclarations()
-
-
-
Field Detail
-
XML_URI
protected static final java.lang.String XML_URI
- See Also:
- Constant Field Values
-
XMLNS_URI
protected static final java.lang.String XMLNS_URI
- See Also:
- Constant Field Values
-
TRACE_SIZING
private static final boolean TRACE_SIZING
- See Also:
- Constant Field Values
-
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected final java.lang.String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
- See Also:
- Constant Field Values
-
FEATURE_NAMES_INTERNED
protected final java.lang.String FEATURE_NAMES_INTERNED
- See Also:
- Constant Field Values
-
PROPERTY_SERIALIZER_INDENTATION
protected final java.lang.String PROPERTY_SERIALIZER_INDENTATION
- See Also:
- Constant Field Values
-
PROPERTY_SERIALIZER_LINE_SEPARATOR
protected final java.lang.String PROPERTY_SERIALIZER_LINE_SEPARATOR
- See Also:
- Constant Field Values
-
PROPERTY_LOCATION
protected static final java.lang.String PROPERTY_LOCATION
- See Also:
- Constant Field Values
-
namesInterned
protected boolean namesInterned
-
attributeUseApostrophe
protected boolean attributeUseApostrophe
-
indentationString
protected java.lang.String indentationString
-
lineSeparator
protected java.lang.String lineSeparator
-
location
protected java.lang.String location
-
out
protected java.io.Writer out
-
autoDeclaredPrefixes
protected int autoDeclaredPrefixes
-
depth
protected int depth
-
elNamespace
protected java.lang.String[] elNamespace
-
elName
protected java.lang.String[] elName
-
elNamespaceCount
protected int[] elNamespaceCount
-
namespaceEnd
protected int namespaceEnd
-
namespacePrefix
protected java.lang.String[] namespacePrefix
-
namespaceUri
protected java.lang.String[] namespaceUri
-
finished
protected boolean finished
-
pastRoot
protected boolean pastRoot
-
setPrefixCalled
protected boolean setPrefixCalled
-
startTagIncomplete
protected boolean startTagIncomplete
-
doIndent
protected boolean doIndent
-
seenTag
protected boolean seenTag
-
seenBracket
protected boolean seenBracket
-
seenBracketBracket
protected boolean seenBracketBracket
-
BUF_LEN
private static final int BUF_LEN
-
buf
protected char[] buf
-
precomputedPrefixes
protected static final java.lang.String[] precomputedPrefixes
-
checkNamesInterned
private boolean checkNamesInterned
-
offsetNewLine
protected int offsetNewLine
-
indentationJump
protected int indentationJump
-
indentationBuf
protected char[] indentationBuf
-
maxIndentLevel
protected int maxIndentLevel
-
writeLineSeparator
protected boolean writeLineSeparator
-
writeIndentation
protected boolean writeIndentation
-
-
Method Detail
-
checkInterning
private void checkInterning(java.lang.String name)
-
reset
protected void reset()
-
ensureElementsCapacity
protected void ensureElementsCapacity()
-
ensureNamespacesCapacity
protected void ensureNamespacesCapacity()
-
setFeature
public void setFeature(java.lang.String name, boolean state) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
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 interfaceXmlSerializer
- Throws:
java.lang.IllegalStateException
- If the feature is not supported or can not be setjava.lang.IllegalArgumentException
-
getFeature
public boolean getFeature(java.lang.String name) throws java.lang.IllegalArgumentException
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 interfaceXmlSerializer
- Parameters:
name
- The name of feature to be retrieved.- Returns:
- The value of named feature.
- Throws:
java.lang.IllegalArgumentException
- if feature string is null
-
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 changes.
-
writeIndent
protected void writeIndent() throws java.io.IOException
- Throws:
java.io.IOException
-
setProperty
public void setProperty(java.lang.String name, java.lang.Object value) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
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 interfaceXmlSerializer
- Throws:
java.lang.IllegalStateException
- if the property is not supported or can not be setjava.lang.IllegalArgumentException
-
getProperty
public java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
Description copied from interface:XmlSerializer
Look up the value of a property. The property name is any fully-qualified URI. INOTE: unknown properties are always returned as null
- Specified by:
getProperty
in interfaceXmlSerializer
- Parameters:
name
- The name of property to be retrieved.- Returns:
- The value of named property.
- Throws:
java.lang.IllegalArgumentException
-
getLocation
private java.lang.String getLocation()
-
getWriter
public java.io.Writer getWriter()
-
setOutput
public void setOutput(java.io.Writer writer)
Description copied from interface:XmlSerializer
Set the output to the given writer.WARNING no information about encoding is available!
- Specified by:
setOutput
in interfaceXmlSerializer
-
setOutput
public void setOutput(java.io.OutputStream os, java.lang.String encoding) throws java.io.IOException
Description copied from interface:XmlSerializer
Set to use binary output stream with given encoding.- Specified by:
setOutput
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
startDocument
public void startDocument(java.lang.String encoding, java.lang.Boolean standalone) throws java.io.IOException
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 interfaceXmlSerializer
- Throws:
java.io.IOException
-
endDocument
public void endDocument() throws java.io.IOException
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 interfaceXmlSerializer
- Throws:
java.io.IOException
-
setPrefix
public void setPrefix(java.lang.String prefix, java.lang.String namespace) throws java.io.IOException
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 declaringxmlns:prefix='namespace'
(orxmlns: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 interfaceXmlSerializer
- Parameters:
prefix
- must be not null (or IllegalArgumentException is thrown)namespace
- must be not null- Throws:
java.io.IOException
-
lookupOrDeclarePrefix
protected java.lang.String lookupOrDeclarePrefix(java.lang.String namespace)
-
getPrefix
public java.lang.String getPrefix(java.lang.String namespace, boolean generatePrefix)
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 interfaceXmlSerializer
-
generatePrefix
private java.lang.String generatePrefix(java.lang.String namespace)
-
getDepth
public int getDepth()
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 interfaceXmlSerializer
-
getNamespace
public java.lang.String getNamespace()
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 interfaceXmlSerializer
- Returns:
- namespace set by startTag() that is currently in scope
-
getName
public java.lang.String getName()
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 interfaceXmlSerializer
- Returns:
- namespace set by startTag() that is currently in scope
-
startTag
public XmlSerializer startTag(java.lang.String namespace, java.lang.String name) throws java.io.IOException
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 interfaceXmlSerializer
- Throws:
java.io.IOException
-
attribute
public XmlSerializer attribute(java.lang.String namespace, java.lang.String name, java.lang.String value) throws java.io.IOException
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 interfaceXmlSerializer
- Throws:
java.io.IOException
-
closeStartTag
protected void closeStartTag() throws java.io.IOException
- Throws:
java.io.IOException
-
writeNamespaceDeclarations
private void writeNamespaceDeclarations() throws java.io.IOException
- Throws:
java.io.IOException
-
endTag
public XmlSerializer endTag(java.lang.String namespace, java.lang.String name) throws java.io.IOException
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 interfaceXmlSerializer
- Throws:
java.io.IOException
-
text
public XmlSerializer text(java.lang.String text) throws java.io.IOException
Description copied from interface:XmlSerializer
Writes text, where special XML chars are escaped automatically- Specified by:
text
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
text
public XmlSerializer text(char[] buf, int start, int len) throws java.io.IOException
Description copied from interface:XmlSerializer
Writes text, where special XML chars are escaped automatically- Specified by:
text
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
cdsect
public void cdsect(java.lang.String text) throws java.io.IOException
- Specified by:
cdsect
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
entityRef
public void entityRef(java.lang.String text) throws java.io.IOException
- Specified by:
entityRef
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
processingInstruction
public void processingInstruction(java.lang.String text) throws java.io.IOException
- Specified by:
processingInstruction
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
comment
public void comment(java.lang.String text) throws java.io.IOException
- Specified by:
comment
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
docdecl
public void docdecl(java.lang.String text) throws java.io.IOException
- Specified by:
docdecl
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
ignorableWhitespace
public void ignorableWhitespace(java.lang.String text) throws java.io.IOException
- Specified by:
ignorableWhitespace
in interfaceXmlSerializer
- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException
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 interfaceXmlSerializer
- Throws:
java.io.IOException
-
writeAttributeValue
protected void writeAttributeValue(java.lang.String value, java.io.Writer out) throws java.io.IOException
- Throws:
java.io.IOException
-
writeElementContent
protected void writeElementContent(java.lang.String text, java.io.Writer out) throws java.io.IOException
- Throws:
java.io.IOException
-
writeElementContent
protected void writeElementContent(char[] buf, int off, int len, java.io.Writer out) throws java.io.IOException
- Throws:
java.io.IOException
-
printable
protected static final java.lang.String printable(java.lang.String s)
simple utility method -- good for debugging
-
printable
protected static final java.lang.String printable(char ch)
-
addPrintable
private static void addPrintable(java.lang.StringBuilder retval, char ch)
-
-