Class MXSerializer
- java.lang.Object
-
- org.codehaus.plexus.util.xml.pull.MXSerializer
-
- All Implemented Interfaces:
XmlSerializer
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
Fields Modifier and Type Field Description protected booleanattributeUseApostropheprotected intautoDeclaredPrefixesprotected char[]bufprotected intdepthprotected booleandoIndentprotected String[]elNameprotected String[]elNamespaceprotected int[]elNamespaceCountprotected StringFEATURE_NAMES_INTERNEDprotected StringFEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHEprotected booleanfinishedprotected char[]indentationBufprotected intindentationJumpprotected StringindentationStringprotected StringlineSeparatorprotected Stringlocationprotected intmaxIndentLevelprotected booleannamesInternedprotected intnamespaceEndprotected String[]namespacePrefixprotected String[]namespaceUriprotected intoffsetNewLineprotected Writeroutprotected booleanpastRootprotected static String[]precomputedPrefixesprotected static StringPROPERTY_LOCATIONprotected StringPROPERTY_SERIALIZER_INDENTATIONprotected StringPROPERTY_SERIALIZER_LINE_SEPARATORprotected booleanseenBracketprotected booleanseenBracketBracketprotected booleanseenTagprotected booleansetPrefixCalledprotected booleanstartTagIncompleteprotected booleanwriteIndentationprotected booleanwriteLineSeparatorprotected static StringXML_URIprotected static StringXMLNS_URI
-
Constructor Summary
Constructors Constructor Description MXSerializer()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description XmlSerializerattribute(String namespace, String name, String value)Write an attribute.voidcdsect(String text)protected voidcloseStartTag()voidcomment(String text)voiddocdecl(String text)voidendDocument()Finish writing.XmlSerializerendTag(String namespace, String name)Write end tag.protected voidensureElementsCapacity()protected voidensureNamespacesCapacity()voidentityRef(String text)voidflush()Write all pending output to the stream.intgetDepth()booleangetFeature(String name)Return the current value of the feature with given name.StringgetName()Returns the name of the current element as set by startTag().StringgetNamespace()Returns the namespace URI of the current element as set by startTag().StringgetPrefix(String namespace, boolean generatePrefix)ObjectgetProperty(String name)Look up the value of a property.WritergetWriter()voidignorableWhitespace(String text)protected StringlookupOrDeclarePrefix(String namespace)protected static Stringprintable(char ch)protected static Stringprintable(String s)voidprocessingInstruction(String text)protected voidrebuildIndentationBuf()For maximum efficiency when writing indents the required output is pre-computed This is internal function that recomputes buffer after user requested changes.protected voidreset()voidsetFeature(String name, boolean state)Set feature identified by name (recommended to be URI for uniqueness).voidsetOutput(OutputStream os, String encoding)Set to use binary output stream with given encoding.voidsetOutput(Writer writer)voidsetPrefix(String prefix, String namespace)Binds the given prefix to the given namespace.voidsetProperty(String name, Object value)Set the value of a property.voidstartDocument(String encoding, 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.XmlSerializerstartTag(String namespace, String name)Writes a start tag with the given namespace and name.XmlSerializertext(char[] buf, int start, int len)Writes text, where special XML chars are escaped automaticallyXmlSerializertext(String text)protected voidwriteAttributeValue(String value, Writer out)protected voidwriteElementContent(char[] buf, int off, int len, Writer out)protected voidwriteElementContent(String text, Writer out)protected voidwriteIndent()
-
-
-
Field Detail
-
XML_URI
protected static final String XML_URI
- See Also:
- Constant Field Values
-
XMLNS_URI
protected static final String XMLNS_URI
- See Also:
- Constant Field Values
-
FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
protected final String FEATURE_SERIALIZER_ATTVALUE_USE_APOSTROPHE
- See Also:
- Constant Field Values
-
FEATURE_NAMES_INTERNED
protected final String FEATURE_NAMES_INTERNED
- See Also:
- Constant Field Values
-
PROPERTY_SERIALIZER_INDENTATION
protected final String PROPERTY_SERIALIZER_INDENTATION
- See Also:
- Constant Field Values
-
PROPERTY_SERIALIZER_LINE_SEPARATOR
protected final String PROPERTY_SERIALIZER_LINE_SEPARATOR
- See Also:
- Constant Field Values
-
PROPERTY_LOCATION
protected static final String PROPERTY_LOCATION
- See Also:
- Constant Field Values
-
namesInterned
protected boolean namesInterned
-
attributeUseApostrophe
protected boolean attributeUseApostrophe
-
indentationString
protected String indentationString
-
lineSeparator
protected String lineSeparator
-
location
protected String location
-
out
protected Writer out
-
autoDeclaredPrefixes
protected int autoDeclaredPrefixes
-
depth
protected int depth
-
elNamespace
protected String[] elNamespace
-
elName
protected String[] elName
-
elNamespaceCount
protected int[] elNamespaceCount
-
namespaceEnd
protected int namespaceEnd
-
namespacePrefix
protected String[] namespacePrefix
-
namespaceUri
protected 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
protected char[] buf
-
precomputedPrefixes
protected static final String[] precomputedPrefixes
-
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
-
reset
protected void reset()
-
ensureElementsCapacity
protected void ensureElementsCapacity()
-
ensureNamespacesCapacity
protected void ensureNamespacesCapacity()
-
setFeature
public void setFeature(String name, boolean state) throws IllegalArgumentException, IllegalStateException
Description copied from interface:XmlSerializerSet 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:
setFeaturein interfaceXmlSerializer- Parameters:
name- feature namestate- feature state- Throws:
IllegalStateException- If the feature is not supported or can not be setIllegalArgumentException
-
getFeature
public boolean getFeature(String name) throws IllegalArgumentException
Description copied from interface:XmlSerializerReturn the current value of the feature with given name.NOTE: unknown properties are always returned as null
- Specified by:
getFeaturein interfaceXmlSerializer- 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()
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 IOException- Throws:
IOException
-
setProperty
public void setProperty(String name, Object value) throws IllegalArgumentException, IllegalStateException
Description copied from interface:XmlSerializerSet 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:
setPropertyin interfaceXmlSerializer- Parameters:
name- property namevalue- property value- Throws:
IllegalStateException- if the property is not supported or can not be setIllegalArgumentException
-
getProperty
public Object getProperty(String name) throws IllegalArgumentException
Description copied from interface:XmlSerializerLook up the value of a property. The property name is any fully-qualified URI. INOTE: unknown properties are always returned as null
- Specified by:
getPropertyin interfaceXmlSerializer- Parameters:
name- The name of property to be retrieved.- Returns:
- The value of named property.
- Throws:
IllegalArgumentException
-
getWriter
public Writer getWriter()
-
setOutput
public void setOutput(Writer writer)
- Specified by:
setOutputin interfaceXmlSerializer- Parameters:
writer- Set the output to the given writer.WARNING no information about encoding is available!
-
setOutput
public void setOutput(OutputStream os, String encoding) throws IOException
Description copied from interface:XmlSerializerSet to use binary output stream with given encoding.- Specified by:
setOutputin interfaceXmlSerializer- Parameters:
os- outencoding- encoding- Throws:
IOException- io
-
startDocument
public void startDocument(String encoding, Boolean standalone) throws IOException
Description copied from interface:XmlSerializerWrite <?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:
startDocumentin interfaceXmlSerializer- Parameters:
encoding- document encodingstandalone- standalone flag value- Throws:
IOException- io
-
endDocument
public void endDocument() throws IOExceptionDescription copied from interface:XmlSerializerFinish 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:
endDocumentin interfaceXmlSerializer- Throws:
IOException- io
-
setPrefix
public void setPrefix(String prefix, String namespace) throws IOException
Description copied from interface:XmlSerializerBinds 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:
setPrefixin interfaceXmlSerializer- Parameters:
prefix- must be not null (or IllegalArgumentException is thrown)namespace- must be not null- Throws:
IOException- io
-
getPrefix
public String getPrefix(String namespace, boolean generatePrefix)
- Specified by:
getPrefixin interfaceXmlSerializer- Parameters:
namespace- the namespacegeneratePrefix- to generate the missing prefix- Returns:
- 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
-
getDepth
public int getDepth()
- Specified by:
getDepthin interfaceXmlSerializer- 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
-
getNamespace
public String getNamespace()
Description copied from interface:XmlSerializerReturns 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:
getNamespacein interfaceXmlSerializer- Returns:
- namespace set by startTag() that is currently in scope
-
getName
public String getName()
Description copied from interface:XmlSerializerReturns 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:
getNamein interfaceXmlSerializer- Returns:
- namespace set by startTag() that is currently in scope
-
startTag
public XmlSerializer startTag(String namespace, String name) throws IOException
Description copied from interface:XmlSerializerWrites 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:
startTagin interfaceXmlSerializer- Parameters:
namespace- nsname- tag name- Returns:
- XmlSerializer
- Throws:
IOException- io
-
attribute
public XmlSerializer attribute(String namespace, String name, String value) throws IOException
Description copied from interface:XmlSerializerWrite 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:
attributein interfaceXmlSerializer- Parameters:
namespace- namespace to usename- attribute namevalue- attribute value- Returns:
- XmlSerializer
- Throws:
IOException- io
-
closeStartTag
protected void closeStartTag() throws IOException- Throws:
IOException
-
endTag
public XmlSerializer endTag(String namespace, String name) throws IOException
Description copied from interface:XmlSerializerWrite 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:
endTagin interfaceXmlSerializer- Parameters:
namespace- nsname- tag name- Returns:
- XmlSerializer
- Throws:
IOException- io
-
text
public XmlSerializer text(String text) throws IOException
- Specified by:
textin interfaceXmlSerializer- Parameters:
text- Writes text, where special XML chars are escaped automatically- Returns:
- XmlSerializer
- Throws:
IOException- io
-
text
public XmlSerializer text(char[] buf, int start, int len) throws IOException
Description copied from interface:XmlSerializerWrites text, where special XML chars are escaped automatically- Specified by:
textin interfaceXmlSerializer- Parameters:
buf- charactersstart- startlen- lenght- Returns:
- XmlSerializer
- Throws:
IOException- io
-
cdsect
public void cdsect(String text) throws IOException
- Specified by:
cdsectin interfaceXmlSerializer- Throws:
IOException
-
entityRef
public void entityRef(String text) throws IOException
- Specified by:
entityRefin interfaceXmlSerializer- Throws:
IOException
-
processingInstruction
public void processingInstruction(String text) throws IOException
- Specified by:
processingInstructionin interfaceXmlSerializer- Throws:
IOException
-
comment
public void comment(String text) throws IOException
- Specified by:
commentin interfaceXmlSerializer- Throws:
IOException
-
docdecl
public void docdecl(String text) throws IOException
- Specified by:
docdeclin interfaceXmlSerializer- Throws:
IOException
-
ignorableWhitespace
public void ignorableWhitespace(String text) throws IOException
- Specified by:
ignorableWhitespacein interfaceXmlSerializer- Throws:
IOException
-
flush
public void flush() throws IOExceptionDescription copied from interface:XmlSerializerWrite 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:
flushin interfaceXmlSerializer- Throws:
IOException- io
-
writeAttributeValue
protected void writeAttributeValue(String value, Writer out) throws IOException
- Throws:
IOException
-
writeElementContent
protected void writeElementContent(String text, Writer out) throws IOException
- Throws:
IOException
-
writeElementContent
protected void writeElementContent(char[] buf, int off, int len, Writer out) throws IOException- Throws:
IOException
-
printable
protected static final String printable(char ch)
-
-