| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_391) on Sun Jun 22 17:31:43 IST 2025 --> |
| <title>SerializerBase</title> |
| <meta name="date" content="2025-06-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SerializerBase"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":9,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":9,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":6,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/xml/serializer/SerializerFactory.html" title="class in org.apache.xml.serializer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/xml/serializer/SerializerBase.html" target="_top">Frames</a></li> |
| <li><a href="SerializerBase.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.xml.serializer</div> |
| <h2 title="Class SerializerBase" class="title">Class SerializerBase</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.xml.serializer.SerializerBase</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer">DOMSerializer</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a>, <a href="../../../../org/apache/xml/serializer/ExtendedLexicalHandler.html" title="interface in org.apache.xml.serializer">ExtendedLexicalHandler</a>, <a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a>, <a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer">Serializer</a>, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ToSAXHandler.html" title="class in org.apache.xml.serializer">ToSAXHandler</a>, <a href="../../../../org/apache/xml/serializer/ToStream.html" title="class in org.apache.xml.serializer">ToStream</a>, <a href="../../../../org/apache/xml/serializer/ToUnknownStream.html" title="class in org.apache.xml.serializer">ToUnknownStream</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">SerializerBase</span> |
| extends java.lang.Object |
| implements <a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></pre> |
| <div class="block">This class acts as a base class for the XML "serializers" |
| and the stream serializers. |
| It contains a number of common fields and methods.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#CDATA_CONTINUE">CDATA_CONTINUE</a></span></code> |
| <div class="block">To insert ]]> in a CDATA section by ending the last CDATA section with |
| ]] and starting the next CDATA section with ></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#CDATA_DELIMITER_CLOSE">CDATA_DELIMITER_CLOSE</a></span></code> |
| <div class="block">The constant "]]>"</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#CDATA_DELIMITER_OPEN">CDATA_DELIMITER_OPEN</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#DEFAULT_SAX_SERIALIZER">DEFAULT_SAX_SERIALIZER</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#EMPTYSTRING">EMPTYSTRING</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#ENTITY_AMP">ENTITY_AMP</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#ENTITY_CRLF">ENTITY_CRLF</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#ENTITY_GT">ENTITY_GT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#ENTITY_LT">ENTITY_LT</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#ENTITY_QUOT">ENTITY_QUOT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected char[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_attrBuff">m_attrBuff</a></span></code> |
| <div class="block">A utility buffer for converting Strings passed to |
| attribute methods to character arrays.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/xml/serializer/AttributesImplSerializer.html" title="class in org.apache.xml.serializer">AttributesImplSerializer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_attributes">m_attributes</a></span></code> |
| <div class="block">All the attributes of the current element, collected from |
| startPrefixMapping() calls, or addAddtribute() calls, or |
| from the SAX attributes in a startElement() call.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.Hashtable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_CdataElems">m_CdataElems</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_cdataTagOpen">m_cdataTagOpen</a></span></code> |
| <div class="block">True if a trailing "]]>" still needs to be written to be |
| written out.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected char[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_charsBuff">m_charsBuff</a></span></code> |
| <div class="block">A utility buffer for converting Strings passed to |
| character() methods to character arrays.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_doctypePublic">m_doctypePublic</a></span></code> |
| <div class="block">The public ID for the doc type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_doctypeSystem">m_doctypeSystem</a></span></code> |
| <div class="block">The System ID for the doc type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_doIndent">m_doIndent</a></span></code> |
| <div class="block">Flag to tell if indenting (pretty-printing) is on.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.xml.serializer.ElemContext</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_elemContext">m_elemContext</a></span></code> |
| <div class="block">A reference to "stack frame" corresponding to |
| the current element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_indentAmount">m_indentAmount</a></span></code> |
| <div class="block">Amount to indent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_inEntityRef">m_inEntityRef</a></span></code> |
| <div class="block">Tells if we're in an EntityRef event.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_inExternalDTD">m_inExternalDTD</a></span></code> |
| <div class="block">This flag is set while receiving events from the external DTD</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_mediatype">m_mediatype</a></span></code> |
| <div class="block">The mediatype.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_needToCallStartDocument">m_needToCallStartDocument</a></span></code> |
| <div class="block">True if we still need to call startDocumentInternal().</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_output_method">m_output_method</a></span></code> |
| <div class="block">An XSL stylesheet's xsl:output 'method' value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/xml/serializer/NamespaceMappings.html" title="class in org.apache.xml.serializer">NamespaceMappings</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_prefixMap">m_prefixMap</a></span></code> |
| <div class="block">Namespace support, that keeps track of currently defined |
| prefix/uri mappings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_shouldNotWriteXMLHeader">m_shouldNotWriteXMLHeader</a></span></code> |
| <div class="block">Tells if we should write the XML declaration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected javax.xml.transform.SourceLocator</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_sourceLocator">m_sourceLocator</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_standaloneWasSpecified">m_standaloneWasSpecified</a></span></code> |
| <div class="block">True if standalone was specified.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_StringOfCDATASections">m_StringOfCDATASections</a></span></code> |
| <div class="block">The CDATA section names stored in a whitespace separateed list with |
| each element being a word of the form "{uri}localName" This list |
| comes from the cdata-section-elements attribute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/xml/serializer/SerializerTrace.html" title="interface in org.apache.xml.serializer">SerializerTrace</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_tracer">m_tracer</a></span></code> |
| <div class="block">Handle for firing generate events.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_version">m_version</a></span></code> |
| <div class="block">Tells the XML version, for writing out to the XML decl.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.io.Writer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#m_writer">m_writer</a></span></code> |
| <div class="block">The writer to send output to.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#PKG_NAME">PKG_NAME</a></span></code> |
| <div class="block">The name of the package that this class is in.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#PKG_PATH">PKG_PATH</a></span></code> |
| <div class="block">The same as the name of the package that this class is in |
| except that '.' are replaced with '/'.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#XML_PREFIX">XML_PREFIX</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#XMLNS_PREFIX">XMLNS_PREFIX</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#XMLNS_URI">XMLNS_URI</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#XMLVERSION10">XMLVERSION10</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#XMLVERSION11">XMLVERSION11</a></span></code> |
| <div class="block">Define the XML version.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.xml.serializer.ExtendedContentHandler"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.xml.serializer.<a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></h3> |
| <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#HTML_ATTREMPTY">HTML_ATTREMPTY</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#HTML_ATTRURL">HTML_ATTRURL</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#NO_BAD_CHARS">NO_BAD_CHARS</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#addAttribute-java.lang.String-java.lang.String-">addAttribute</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Adds the given attribute to the set of collected attributes, |
| but only if there is a currently open element.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">addAttribute</a></span>(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value)</code> |
| <div class="block">This method adds an attribute the the current element, |
| but should not be used for an xsl:attribute child.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-">addAttribute</a></span>(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value, |
| boolean XSLAttribute)</code> |
| <div class="block">Adds the given attribute to the set of collected attributes , but only if |
| there is a currently open element.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#addAttributeAlways-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-">addAttributeAlways</a></span>(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value, |
| boolean XSLAttribute)</code> |
| <div class="block">Adds the given attribute to the set of attributes, even if there is |
| no currently open element.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#addAttributes-org.xml.sax.Attributes-">addAttributes</a></span>(org.xml.sax.Attributes atts)</code> |
| <div class="block">Add the given attributes to the currently collected ones.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#addXSLAttribute-java.lang.String-java.lang.String-java.lang.String-">addXSLAttribute</a></span>(java.lang.String name, |
| java.lang.String value, |
| java.lang.String uri)</code> |
| <div class="block">Adds the given xsl:attribute to the set of collected attributes, |
| but only if there is a currently open element.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.xml.sax.ContentHandler</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#asContentHandler--">asContentHandler</a></span>()</code> |
| <div class="block">Return a <code>ContentHandler</code> interface into this serializer.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#asDOM3Serializer--">asDOM3Serializer</a></span>()</code> |
| <div class="block">Return a <a href="../../../../org/apache/xml/serializer/DOM3Serializer.html" title="interface in org.apache.xml.serializer"><code>DOM3Serializer</code></a> interface into this serializer.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer">DOMSerializer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#asDOMSerializer--">asDOMSerializer</a></span>()</code> |
| <div class="block">Return a <a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><code>DOMSerializer</code></a> interface into this serializer.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#characters-org.w3c.dom.Node-">characters</a></span>(org.w3c.dom.Node node)</code> |
| <div class="block">This method gets the nodes value as a String and uses that String as if |
| it were an input character notification.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#close--">close</a></span>()</code> |
| <div class="block">Flush and close the underlying java.io.Writer.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#comment-java.lang.String-">comment</a></span>(java.lang.String data)</code> |
| <div class="block">Receive notification of a comment.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#documentIsEmpty--">documentIsEmpty</a></span>()</code> |
| <div class="block">Return true if nothing has been sent to this result tree yet.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitCDATAEvent-char:A-int-int-">emitCDATAEvent</a></span>(char[] chars, |
| int start, |
| int length)</code> |
| <div class="block">Report the CDATA trace event.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitCharEvent-char:A-int-int-">emitCharEvent</a></span>(char[] chars, |
| int start, |
| int length)</code> |
| <div class="block">Report the characters trace event.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitCommentEvent-char:A-int-int-">emitCommentEvent</a></span>(char[] chars, |
| int start, |
| int length)</code> |
| <div class="block">Report the comment trace event.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitEndDoc--">emitEndDoc</a></span>()</code> |
| <div class="block">Emit an end document trace event.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitEndElem-java.lang.String-">emitEndElem</a></span>(java.lang.String name)</code> |
| <div class="block">Emit an end element trace event.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitEndEntity-java.lang.String-">emitEndEntity</a></span>(java.lang.String name)</code> |
| <div class="block">Emit an end entity trace event.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitEntityReference-java.lang.String-">emitEntityReference</a></span>(java.lang.String name)</code> |
| <div class="block">Emit an entity reference trace event.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitEscapingEvent-java.lang.String-java.lang.String-">emitEscapingEvent</a></span>(java.lang.String name, |
| java.lang.String data)</code> |
| <div class="block">Emit an PI trace event.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitStartDoc--">emitStartDoc</a></span>()</code> |
| <div class="block">Emit start document trace event.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitStartElem-java.lang.String-">emitStartElem</a></span>(java.lang.String elemName)</code> |
| <div class="block">Report the start element trace event.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#emitStartEntity-java.lang.String-">emitStartEntity</a></span>(java.lang.String name)</code> |
| <div class="block">Emit start entity trace event.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#endEntity-java.lang.String-">endEntity</a></span>(java.lang.String name)</code> |
| <div class="block">Report the end of an entity.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#entityReference-java.lang.String-">entityReference</a></span>(java.lang.String name)</code> |
| <div class="block">Entity reference event.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#error-org.xml.sax.SAXParseException-">error</a></span>(org.xml.sax.SAXParseException exc)</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#fatalError-org.xml.sax.SAXParseException-">fatalError</a></span>(org.xml.sax.SAXParseException exc)</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/xml/serializer/CharacterMapConfig.html" title="class in org.apache.xml.serializer">CharacterMapConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getCharMapConfig--">getCharMapConfig</a></span>()</code> |
| <div class="block">Get xsl:character-map run-time configuration object.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getDoctypePublic--">getDoctypePublic</a></span>()</code> |
| <div class="block">Returns the previously set value of the value to be used as the public |
| identifier in the document type declaration (DTD).</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getDoctypeSystem--">getDoctypeSystem</a></span>()</code> |
| <div class="block">Returns the previously set value of the value to be used |
| as the system identifier in the document type declaration (DTD).</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getEncoding--">getEncoding</a></span>()</code> |
| <div class="block">Returns the character encoding to be used in the output document.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getIndent--">getIndent</a></span>()</code> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getIndentAmount--">getIndentAmount</a></span>()</code> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>protected static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getLocalName-java.lang.String-">getLocalName</a></span>(java.lang.String qname)</code> |
| <div class="block">Returns the local name of a qualified name.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getMediaType--">getMediaType</a></span>()</code> |
| <div class="block">Gets the mediatype the media-type or MIME type associated with the output |
| document.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/xml/serializer/NamespaceMappings.html" title="class in org.apache.xml.serializer">NamespaceMappings</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getNamespaceMappings--">getNamespaceMappings</a></span>()</code> |
| <div class="block">Some users of the serializer may need the current namespace mappings.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getNamespaceURI-java.lang.String-boolean-">getNamespaceURI</a></span>(java.lang.String qname, |
| boolean isElement)</code> |
| <div class="block">Returns the URI of an element or attribute.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getNamespaceURIFromPrefix-java.lang.String-">getNamespaceURIFromPrefix</a></span>(java.lang.String prefix)</code> |
| <div class="block">Returns the URI of prefix (if any).</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getOmitXMLDeclaration--">getOmitXMLDeclaration</a></span>()</code> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getOutputProperty-java.lang.String-">getOutputProperty</a></span>(java.lang.String name)</code> |
| <div class="block">Get the value of an output property, |
| the explicit value, if any, otherwise the |
| default value, if any, otherwise null.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getOutputPropertyDefault-java.lang.String-">getOutputPropertyDefault</a></span>(java.lang.String name)</code> |
| <div class="block">Get the default value of an xsl:output property, |
| which would be null only if no default value exists |
| for the property.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getOutputPropertyNonDefault-java.lang.String-">getOutputPropertyNonDefault</a></span>(java.lang.String name)</code> |
| <div class="block">Get the value of an output property, |
| not the default value.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getPrefix-java.lang.String-">getPrefix</a></span>(java.lang.String namespaceURI)</code> |
| <div class="block">Returns the prefix currently pointing to the given URI (if any).</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>protected static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getPrefixPart-java.lang.String-">getPrefixPart</a></span>(java.lang.String qname)</code> |
| <div class="block">Returns the local name of a qualified name.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getStandalone--">getStandalone</a></span>()</code> |
| <div class="block">Gets the XSL standalone attribute.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>javax.xml.transform.Transformer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getTransformer--">getTransformer</a></span>()</code> |
| <div class="block">Gets the transformer associated with this serializer</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#getVersion--">getVersion</a></span>()</code> |
| <div class="block">Gets the version of the output format.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#initCDATA--">initCDATA</a></span>()</code> |
| <div class="block">Initialize global variables.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#isCdataSection--">isCdataSection</a></span>()</code> |
| <div class="block">Return true if the current element in m_elemContext |
| is a CDATA section.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#namespaceAfterStartElement-java.lang.String-java.lang.String-">namespaceAfterStartElement</a></span>(java.lang.String uri, |
| java.lang.String prefix)</code> |
| <div class="block">This method is used when a prefix/uri namespace mapping |
| is indicated after the element was started with a |
| startElement() and before and endElement().</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#notationDecl-java.lang.String-java.lang.String-java.lang.String-">notationDecl</a></span>(java.lang.String arg0, |
| java.lang.String arg1, |
| java.lang.String arg2)</code> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#patchName-java.lang.String-">patchName</a></span>(java.lang.String qname)</code> |
| <div class="block">If at runtime, when the qname of the attribute is |
| known, another prefix is specified for the attribute, then we can |
| patch or hack the name with this method.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#reset--">reset</a></span>()</code> |
| <div class="block">This method resets the serializer.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setCdataSectionElements-java.util.Vector-">setCdataSectionElements</a></span>(java.util.Vector URI_and_localNames)</code> |
| <div class="block">Sets the value coming from the xsl:output cdata-section-elements |
| stylesheet property.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setCharMapConfig-org.apache.xml.serializer.CharacterMapConfig-">setCharMapConfig</a></span>(<a href="../../../../org/apache/xml/serializer/CharacterMapConfig.html" title="class in org.apache.xml.serializer">CharacterMapConfig</a> charMapConfig)</code> |
| <div class="block">Set xsl:character-map run-time configuration object.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setDoctype-java.lang.String-java.lang.String-">setDoctype</a></span>(java.lang.String doctypeSystem, |
| java.lang.String doctypePublic)</code> |
| <div class="block">Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setDoctypePublic-java.lang.String-">setDoctypePublic</a></span>(java.lang.String doctypePublic)</code> |
| <div class="block">Set the value coming from the xsl:output doctype-public stylesheet attribute.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setDoctypeSystem-java.lang.String-">setDoctypeSystem</a></span>(java.lang.String doctypeSystem)</code> |
| <div class="block">Set the value coming from the xsl:output doctype-system stylesheet attribute.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setDocumentLocator-org.xml.sax.Locator-">setDocumentLocator</a></span>(org.xml.sax.Locator locator)</code> |
| <div class="block">Receive an object for locating the origin of SAX document events.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setDTDEntityExpansion-boolean-">setDTDEntityExpansion</a></span>(boolean expand)</code> |
| <div class="block">If set to false the serializer does not expand DTD entities, |
| but leaves them as is, the default value is true.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setEncoding-java.lang.String-">setEncoding</a></span>(java.lang.String encoding)</code> |
| <div class="block">Sets the character encoding coming from the xsl:output encoding stylesheet attribute.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setIndent-boolean-">setIndent</a></span>(boolean doIndent)</code> |
| <div class="block">Sets the value coming from the xsl:output indent stylesheet |
| attribute.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setIndentAmount-int-">setIndentAmount</a></span>(int m_indentAmount)</code> |
| <div class="block">Sets the indentation amount.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setMediaType-java.lang.String-">setMediaType</a></span>(java.lang.String mediaType)</code> |
| <div class="block">Sets the value coming from the xsl:output media-type stylesheet attribute.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setNamespaceMappings-org.apache.xml.serializer.NamespaceMappings-">setNamespaceMappings</a></span>(<a href="../../../../org/apache/xml/serializer/NamespaceMappings.html" title="class in org.apache.xml.serializer">NamespaceMappings</a> mappings)</code> |
| <div class="block">Used only by TransformerSnapshotImpl to restore the serialization |
| to a previous state.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setOmitXMLDeclaration-boolean-">setOmitXMLDeclaration</a></span>(boolean b)</code> |
| <div class="block">Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setOutputMethod-java.lang.String-">setOutputMethod</a></span>(java.lang.String outputMethod)</code> |
| <div class="block">Set XSL transform's xsl:output 'method' value.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setOutputProperty-java.lang.String-java.lang.String-">setOutputProperty</a></span>(java.lang.String name, |
| java.lang.String val)</code> |
| <div class="block">Set the value for the output property, typically from |
| an xsl:output element, but this does not change what |
| the default value is.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setOutputPropertyDefault-java.lang.String-java.lang.String-">setOutputPropertyDefault</a></span>(java.lang.String name, |
| java.lang.String val)</code> |
| <div class="block">Set the default value for an output property, but this does |
| not impact any explicitly set value.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setSourceLocator-javax.xml.transform.SourceLocator-">setSourceLocator</a></span>(javax.xml.transform.SourceLocator locator)</code> |
| <div class="block">This method is used to set the source locator, which might be used to |
| generated an error message.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setStandalone-java.lang.String-">setStandalone</a></span>(java.lang.String standalone)</code> |
| <div class="block">Sets the value coming from the xsl:output standalone stylesheet attribute.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setStandaloneInternal-java.lang.String-">setStandaloneInternal</a></span>(java.lang.String standalone)</code> |
| <div class="block">Sets the XSL standalone attribute, but does not remember if this is a |
| default or explicite setting.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setTransformer-javax.xml.transform.Transformer-">setTransformer</a></span>(javax.xml.transform.Transformer t)</code> |
| <div class="block">Sets the transformer associated with this serializer.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#setVersion-java.lang.String-">setVersion</a></span>(java.lang.String version)</code> |
| <div class="block">Sets the value coming from the xsl:output version attribute.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#startDocument--">startDocument</a></span>()</code> |
| <div class="block">Receive notification of the beginning of a document.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#startDocumentInternal--">startDocumentInternal</a></span>()</code> |
| <div class="block">This method handles what needs to be done at a startDocument() call, |
| whether from an external caller, or internally called in the |
| serializer.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#unparsedEntityDecl-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">unparsedEntityDecl</a></span>(java.lang.String arg0, |
| java.lang.String arg1, |
| java.lang.String arg2, |
| java.lang.String arg3)</code> </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/serializer/SerializerBase.html#warning-org.xml.sax.SAXParseException-">warning</a></span>(org.xml.sax.SAXParseException exc)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.xml.serializer.SerializationHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.xml.serializer.<a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></h3> |
| <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#flushPending--">flushPending</a>, <a href="../../../../org/apache/xml/serializer/SerializationHandler.html#serialize-org.w3c.dom.Node-">serialize</a>, <a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setContentHandler-org.xml.sax.ContentHandler-">setContentHandler</a>, <a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setEscaping-boolean-">setEscaping</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.xml.serializer.ExtendedContentHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.xml.serializer.<a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></h3> |
| <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addUniqueAttribute-java.lang.String-java.lang.String-int-">addUniqueAttribute</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#characters-java.lang.String-">characters</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#endElement-java.lang.String-">endElement</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#startElement-java.lang.String-">startElement</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#startElement-java.lang.String-java.lang.String-java.lang.String-">startElement</a>, <a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#startPrefixMapping-java.lang.String-java.lang.String-boolean-">startPrefixMapping</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.xml.sax.ContentHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.xml.sax.ContentHandler</h3> |
| <code>characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, skippedEntity, startElement, startPrefixMapping</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.xml.sax.ext.LexicalHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.xml.sax.ext.LexicalHandler</h3> |
| <code>comment, endCDATA, endDTD, startCDATA, startDTD, startEntity</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.xml.sax.ext.DeclHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.xml.sax.ext.DeclHandler</h3> |
| <code>attributeDecl, elementDecl, externalEntityDecl, internalEntityDecl</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.xml.serializer.Serializer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.xml.serializer.<a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer">Serializer</a></h3> |
| <code><a href="../../../../org/apache/xml/serializer/Serializer.html#getOutputFormat--">getOutputFormat</a>, <a href="../../../../org/apache/xml/serializer/Serializer.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/xml/serializer/Serializer.html#getWriter--">getWriter</a>, <a href="../../../../org/apache/xml/serializer/Serializer.html#setOutputFormat-java.util.Properties-">setOutputFormat</a>, <a href="../../../../org/apache/xml/serializer/Serializer.html#setOutputStream-java.io.OutputStream-">setOutputStream</a>, <a href="../../../../org/apache/xml/serializer/Serializer.html#setWriter-java.io.Writer-">setWriter</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="PKG_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PKG_NAME</h4> |
| <pre>public static final java.lang.String PKG_NAME</pre> |
| <div class="block">The name of the package that this class is in. |
| <p> |
| Not a public API.</div> |
| </li> |
| </ul> |
| <a name="PKG_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PKG_PATH</h4> |
| <pre>public static final java.lang.String PKG_PATH</pre> |
| <div class="block">The same as the name of the package that this class is in |
| except that '.' are replaced with '/'. |
| <p> |
| Not a public API.</div> |
| </li> |
| </ul> |
| <a name="m_needToCallStartDocument"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_needToCallStartDocument</h4> |
| <pre>protected boolean m_needToCallStartDocument</pre> |
| <div class="block">True if we still need to call startDocumentInternal().</div> |
| </li> |
| </ul> |
| <a name="m_cdataTagOpen"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_cdataTagOpen</h4> |
| <pre>protected boolean m_cdataTagOpen</pre> |
| <div class="block">True if a trailing "]]>" still needs to be written to be |
| written out. Used to merge adjacent CDATA sections.</div> |
| </li> |
| </ul> |
| <a name="m_attributes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_attributes</h4> |
| <pre>protected <a href="../../../../org/apache/xml/serializer/AttributesImplSerializer.html" title="class in org.apache.xml.serializer">AttributesImplSerializer</a> m_attributes</pre> |
| <div class="block">All the attributes of the current element, collected from |
| startPrefixMapping() calls, or addAddtribute() calls, or |
| from the SAX attributes in a startElement() call.</div> |
| </li> |
| </ul> |
| <a name="m_inEntityRef"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_inEntityRef</h4> |
| <pre>protected boolean m_inEntityRef</pre> |
| <div class="block">Tells if we're in an EntityRef event.</div> |
| </li> |
| </ul> |
| <a name="m_inExternalDTD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_inExternalDTD</h4> |
| <pre>protected boolean m_inExternalDTD</pre> |
| <div class="block">This flag is set while receiving events from the external DTD</div> |
| </li> |
| </ul> |
| <a name="m_doctypeSystem"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_doctypeSystem</h4> |
| <pre>protected java.lang.String m_doctypeSystem</pre> |
| <div class="block">The System ID for the doc type.</div> |
| </li> |
| </ul> |
| <a name="m_doctypePublic"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_doctypePublic</h4> |
| <pre>protected java.lang.String m_doctypePublic</pre> |
| <div class="block">The public ID for the doc type.</div> |
| </li> |
| </ul> |
| <a name="m_shouldNotWriteXMLHeader"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_shouldNotWriteXMLHeader</h4> |
| <pre>protected boolean m_shouldNotWriteXMLHeader</pre> |
| <div class="block">Tells if we should write the XML declaration.</div> |
| </li> |
| </ul> |
| <a name="m_standaloneWasSpecified"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_standaloneWasSpecified</h4> |
| <pre>protected boolean m_standaloneWasSpecified</pre> |
| <div class="block">True if standalone was specified.</div> |
| </li> |
| </ul> |
| <a name="m_doIndent"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_doIndent</h4> |
| <pre>protected boolean m_doIndent</pre> |
| <div class="block">Flag to tell if indenting (pretty-printing) is on.</div> |
| </li> |
| </ul> |
| <a name="m_indentAmount"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_indentAmount</h4> |
| <pre>protected int m_indentAmount</pre> |
| <div class="block">Amount to indent.</div> |
| </li> |
| </ul> |
| <a name="m_version"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_version</h4> |
| <pre>protected java.lang.String m_version</pre> |
| <div class="block">Tells the XML version, for writing out to the XML decl.</div> |
| </li> |
| </ul> |
| <a name="m_mediatype"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_mediatype</h4> |
| <pre>protected java.lang.String m_mediatype</pre> |
| <div class="block">The mediatype. Not used right now.</div> |
| </li> |
| </ul> |
| <a name="m_prefixMap"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_prefixMap</h4> |
| <pre>protected <a href="../../../../org/apache/xml/serializer/NamespaceMappings.html" title="class in org.apache.xml.serializer">NamespaceMappings</a> m_prefixMap</pre> |
| <div class="block">Namespace support, that keeps track of currently defined |
| prefix/uri mappings. As processed elements come and go, so do |
| the associated mappings for that element.</div> |
| </li> |
| </ul> |
| <a name="m_tracer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_tracer</h4> |
| <pre>protected <a href="../../../../org/apache/xml/serializer/SerializerTrace.html" title="interface in org.apache.xml.serializer">SerializerTrace</a> m_tracer</pre> |
| <div class="block">Handle for firing generate events. This interface may be implemented |
| by the referenced transformer object.</div> |
| </li> |
| </ul> |
| <a name="m_sourceLocator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_sourceLocator</h4> |
| <pre>protected javax.xml.transform.SourceLocator m_sourceLocator</pre> |
| </li> |
| </ul> |
| <a name="m_writer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_writer</h4> |
| <pre>protected java.io.Writer m_writer</pre> |
| <div class="block">The writer to send output to. This field is only used in the ToStream |
| serializers, but exists here just so that the emitStartDoc() and |
| other emit... methods can flush this writer when tracing.</div> |
| </li> |
| </ul> |
| <a name="m_elemContext"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_elemContext</h4> |
| <pre>protected org.apache.xml.serializer.ElemContext m_elemContext</pre> |
| <div class="block">A reference to "stack frame" corresponding to |
| the current element. Such a frame is pushed at a startElement() |
| and popped at an endElement(). This frame contains information about |
| the element, such as its namespace URI.</div> |
| </li> |
| </ul> |
| <a name="m_charsBuff"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_charsBuff</h4> |
| <pre>protected char[] m_charsBuff</pre> |
| <div class="block">A utility buffer for converting Strings passed to |
| character() methods to character arrays. |
| Reusing this buffer means not creating a new character array |
| everytime and it runs faster.</div> |
| </li> |
| </ul> |
| <a name="m_attrBuff"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_attrBuff</h4> |
| <pre>protected char[] m_attrBuff</pre> |
| <div class="block">A utility buffer for converting Strings passed to |
| attribute methods to character arrays. |
| Reusing this buffer means not creating a new character array |
| everytime and it runs faster.</div> |
| </li> |
| </ul> |
| <a name="m_output_method"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_output_method</h4> |
| <pre>protected java.lang.String m_output_method</pre> |
| <div class="block">An XSL stylesheet's xsl:output 'method' value.</div> |
| </li> |
| </ul> |
| <a name="m_StringOfCDATASections"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_StringOfCDATASections</h4> |
| <pre>protected java.lang.String m_StringOfCDATASections</pre> |
| <div class="block">The CDATA section names stored in a whitespace separateed list with |
| each element being a word of the form "{uri}localName" This list |
| comes from the cdata-section-elements attribute. |
| |
| This field replaces m_cdataSectionElements Vector.</div> |
| </li> |
| </ul> |
| <a name="m_CdataElems"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_CdataElems</h4> |
| <pre>protected java.util.Hashtable m_CdataElems</pre> |
| </li> |
| </ul> |
| <a name="CDATA_CONTINUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CDATA_CONTINUE</h4> |
| <pre>public static final java.lang.String CDATA_CONTINUE</pre> |
| <div class="block">To insert ]]> in a CDATA section by ending the last CDATA section with |
| ]] and starting the next CDATA section with ></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.CDATA_CONTINUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CDATA_DELIMITER_CLOSE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CDATA_DELIMITER_CLOSE</h4> |
| <pre>public static final java.lang.String CDATA_DELIMITER_CLOSE</pre> |
| <div class="block">The constant "]]>"</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.CDATA_DELIMITER_CLOSE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CDATA_DELIMITER_OPEN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CDATA_DELIMITER_OPEN</h4> |
| <pre>public static final java.lang.String CDATA_DELIMITER_OPEN</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.CDATA_DELIMITER_OPEN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="EMPTYSTRING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTYSTRING</h4> |
| <pre>public static final java.lang.String EMPTYSTRING</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.EMPTYSTRING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENTITY_AMP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENTITY_AMP</h4> |
| <pre>public static final java.lang.String ENTITY_AMP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.ENTITY_AMP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENTITY_CRLF"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENTITY_CRLF</h4> |
| <pre>public static final java.lang.String ENTITY_CRLF</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.ENTITY_CRLF">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENTITY_GT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENTITY_GT</h4> |
| <pre>public static final java.lang.String ENTITY_GT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.ENTITY_GT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENTITY_LT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENTITY_LT</h4> |
| <pre>public static final java.lang.String ENTITY_LT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.ENTITY_LT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENTITY_QUOT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENTITY_QUOT</h4> |
| <pre>public static final java.lang.String ENTITY_QUOT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.ENTITY_QUOT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="XML_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XML_PREFIX</h4> |
| <pre>public static final java.lang.String XML_PREFIX</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.XML_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="XMLNS_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLNS_PREFIX</h4> |
| <pre>public static final java.lang.String XMLNS_PREFIX</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.XMLNS_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="XMLNS_URI"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLNS_URI</h4> |
| <pre>public static final java.lang.String XMLNS_URI</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.XMLNS_URI">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_SAX_SERIALIZER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SAX_SERIALIZER</h4> |
| <pre>public static final java.lang.String DEFAULT_SAX_SERIALIZER</pre> |
| </li> |
| </ul> |
| <a name="XMLVERSION11"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLVERSION11</h4> |
| <pre>public static final java.lang.String XMLVERSION11</pre> |
| <div class="block">Define the XML version.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.XMLVERSION11">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="XMLVERSION10"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>XMLVERSION10</h4> |
| <pre>public static final java.lang.String XMLVERSION10</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.xml.serializer.SerializerBase.XMLVERSION10">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="emitEndElem-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitEndElem</h4> |
| <pre>protected void emitEndElem(java.lang.String name) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit an end element trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of element</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitCharEvent-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitCharEvent</h4> |
| <pre>protected void emitCharEvent(char[] chars, |
| int start, |
| int length) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Report the characters trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chars</code> - content of characters</dd> |
| <dd><code>start</code> - starting index of characters to output</dd> |
| <dd><code>length</code> - number of characters to output</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="comment-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>comment</h4> |
| <pre>public void comment(java.lang.String data) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Receive notification of a comment.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedLexicalHandler.html#comment-java.lang.String-">comment</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedLexicalHandler.html" title="interface in org.apache.xml.serializer">ExtendedLexicalHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - the comment, but unlike the SAX comment() method this |
| method takes a String rather than a character array.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedLexicalHandler.html#comment-java.lang.String-"><code>ExtendedLexicalHandler.comment(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="patchName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>patchName</h4> |
| <pre>protected java.lang.String patchName(java.lang.String qname)</pre> |
| <div class="block">If at runtime, when the qname of the attribute is |
| known, another prefix is specified for the attribute, then we can |
| patch or hack the name with this method. For |
| a qname of the form "ns?:otherprefix:name", this function patches the |
| qname by simply ignoring "otherprefix". |
| TODO: This method is a HACK! We do not have access to the |
| XML file, it sometimes generates a NS prefix of the form "ns?" for |
| an attribute.</div> |
| </li> |
| </ul> |
| <a name="getLocalName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalName</h4> |
| <pre>protected static java.lang.String getLocalName(java.lang.String qname)</pre> |
| <div class="block">Returns the local name of a qualified name. If the name has no prefix, |
| then it works as the identity (SAX2).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - the qualified name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name, but excluding any prefix and colon.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDocumentLocator-org.xml.sax.Locator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDocumentLocator</h4> |
| <pre>public void setDocumentLocator(org.xml.sax.Locator locator)</pre> |
| <div class="block">Receive an object for locating the origin of SAX document events.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setDocumentLocator</code> in interface <code>org.xml.sax.ContentHandler</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locator</code> - An object that can return the location of any SAX document |
| event. |
| |
| Receive an object for locating the origin of SAX document events. |
| |
| <p>SAX parsers are strongly encouraged (though not absolutely |
| required) to supply a locator: if it does so, it must supply |
| the locator to the application by invoking this method before |
| invoking any of the other methods in the DocumentHandler |
| interface.</p> |
| |
| <p>The locator allows the application to determine the end |
| position of any document-related event, even if the parser is |
| not reporting an error. Typically, the application will |
| use this information for reporting its own errors (such as |
| character content that does not match an application's |
| business rules). The information returned by the locator |
| is probably not sufficient for use with a search engine.</p> |
| |
| <p>Note that the locator will return correct information only |
| during the invocation of the events in this interface. The |
| application should not attempt to use it at any other time.</p></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre>public void addAttribute(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value, |
| boolean XSLAttribute) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Adds the given attribute to the set of collected attributes , but only if |
| there is a currently open element. |
| |
| An element is currently open if a startElement() notification has |
| occured but the start of the element has not yet been written to the |
| output. In the stream case this means that we have not yet been forced |
| to close the elements opening tag by another notification, such as a |
| character notification.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-">addAttribute</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - the URI of the attribute</dd> |
| <dd><code>localName</code> - the local name of the attribute</dd> |
| <dd><code>rawName</code> - the qualified name of the attribute</dd> |
| <dd><code>type</code> - the type of the attribute (probably CDATA)</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| <dd><code>XSLAttribute</code> - true if this attribute is coming from an xsl:attriute element</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"><code>ExtendedContentHandler.addAttribute(String, String, String, String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttributeAlways-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttributeAlways</h4> |
| <pre>public boolean addAttributeAlways(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value, |
| boolean XSLAttribute)</pre> |
| <div class="block">Adds the given attribute to the set of attributes, even if there is |
| no currently open element. This is useful if a SAX startPrefixMapping() |
| should need to add an attribute before the element name is seen.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - the URI of the attribute</dd> |
| <dd><code>localName</code> - the local name of the attribute</dd> |
| <dd><code>rawName</code> - the qualified name of the attribute</dd> |
| <dd><code>type</code> - the type of the attribute (probably CDATA)</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| <dd><code>XSLAttribute</code> - true if this attribute is coming from an xsl:attribute element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the attribute was added, |
| false if an existing value was replaced.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttribute-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre>public void addAttribute(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Adds the given attribute to the set of collected attributes, |
| but only if there is a currently open element.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addAttribute-java.lang.String-java.lang.String-">addAttribute</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the attribute's qualified name</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addXSLAttribute-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addXSLAttribute</h4> |
| <pre>public void addXSLAttribute(java.lang.String name, |
| java.lang.String value, |
| java.lang.String uri)</pre> |
| <div class="block">Adds the given xsl:attribute to the set of collected attributes, |
| but only if there is a currently open element.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addXSLAttribute-java.lang.String-java.lang.String-java.lang.String-">addXSLAttribute</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the attribute's qualified name (prefix:localName)</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| <dd><code>uri</code> - the URI that the prefix of the name points to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttributes-org.xml.sax.Attributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttributes</h4> |
| <pre>public void addAttributes(org.xml.sax.Attributes atts) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Add the given attributes to the currently collected ones. These |
| attributes are always added, regardless of whether on not an element |
| is currently open.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addAttributes-org.xml.sax.Attributes-">addAttributes</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>atts</code> - List of attributes to add to this list</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asContentHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asContentHandler</h4> |
| <pre>public org.xml.sax.ContentHandler asContentHandler() |
| throws java.io.IOException</pre> |
| <div class="block">Return a <code>ContentHandler</code> interface into this serializer. |
| If the serializer does not support the <code>ContentHandler</code> |
| interface, it should return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/Serializer.html#asContentHandler--">asContentHandler</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer">Serializer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>ContentHandler</code> interface into this serializer, |
| or null if the serializer is not SAX 2 capable</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - An I/O exception occured</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endEntity-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endEntity</h4> |
| <pre>public void endEntity(java.lang.String name) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Report the end of an entity.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>endEntity</code> in interface <code>org.xml.sax.ext.LexicalHandler</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the entity that is ending.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code> - The application may raise an exception.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>LexicalHandler.startEntity(java.lang.String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Flush and close the underlying java.io.Writer. This method applies to |
| ToStream serializers, not ToSAXHandler serializers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ToStream.html" title="class in org.apache.xml.serializer"><code>ToStream</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initCDATA--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initCDATA</h4> |
| <pre>protected void initCDATA()</pre> |
| <div class="block">Initialize global variables.</div> |
| </li> |
| </ul> |
| <a name="getEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncoding</h4> |
| <pre>public java.lang.String getEncoding()</pre> |
| <div class="block">Returns the character encoding to be used in the output document.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the character encoding to be used in the output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncoding</h4> |
| <pre>public void setEncoding(java.lang.String encoding)</pre> |
| <div class="block">Sets the character encoding coming from the xsl:output encoding stylesheet attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>m_encoding</code> - the character encoding</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOmitXMLDeclaration-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOmitXMLDeclaration</h4> |
| <pre>public void setOmitXMLDeclaration(boolean b)</pre> |
| <div class="block">Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>b</code> - true if the XML declaration is to be omitted from the output |
| document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOmitXMLDeclaration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOmitXMLDeclaration</h4> |
| <pre>public boolean getOmitXMLDeclaration()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the XML declaration is to be omitted from the output |
| document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDoctypePublic--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoctypePublic</h4> |
| <pre>public java.lang.String getDoctypePublic()</pre> |
| <div class="block">Returns the previously set value of the value to be used as the public |
| identifier in the document type declaration (DTD).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the public identifier to be used in the DOCTYPE declaration in the |
| output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDoctypePublic-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDoctypePublic</h4> |
| <pre>public void setDoctypePublic(java.lang.String doctypePublic)</pre> |
| <div class="block">Set the value coming from the xsl:output doctype-public stylesheet attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>doctypePublic</code> - the public identifier to be used in the DOCTYPE |
| declaration in the output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDoctypeSystem--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoctypeSystem</h4> |
| <pre>public java.lang.String getDoctypeSystem()</pre> |
| <div class="block">Returns the previously set value of the value to be used |
| as the system identifier in the document type declaration (DTD).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the system identifier to be used in the DOCTYPE declaration in |
| the output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDoctypeSystem-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDoctypeSystem</h4> |
| <pre>public void setDoctypeSystem(java.lang.String doctypeSystem)</pre> |
| <div class="block">Set the value coming from the xsl:output doctype-system stylesheet attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>doctypeSystem</code> - the system identifier to be used in the DOCTYPE |
| declaration in the output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDoctype-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDoctype</h4> |
| <pre>public void setDoctype(java.lang.String doctypeSystem, |
| java.lang.String doctypePublic)</pre> |
| <div class="block">Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>doctypeSystem</code> - the system identifier to be used in the DOCTYPE |
| declaration in the output document.</dd> |
| <dd><code>doctypePublic</code> - the public identifier to be used in the DOCTYPE |
| declaration in the output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStandalone-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStandalone</h4> |
| <pre>public void setStandalone(java.lang.String standalone)</pre> |
| <div class="block">Sets the value coming from the xsl:output standalone stylesheet attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>standalone</code> - a value of "yes" indicates that the |
| <code>standalone</code> delaration is to be included in the output |
| document. This method remembers if the value was explicitly set using |
| this method, verses if the value is the default value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStandaloneInternal-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStandaloneInternal</h4> |
| <pre>protected void setStandaloneInternal(java.lang.String standalone)</pre> |
| <div class="block">Sets the XSL standalone attribute, but does not remember if this is a |
| default or explicite setting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>standalone</code> - "yes" | "no"</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStandalone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStandalone</h4> |
| <pre>public java.lang.String getStandalone()</pre> |
| <div class="block">Gets the XSL standalone attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a value of "yes" if the <code>standalone</code> delaration is to |
| be included in the output document.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>XSLOutputAttributes.getStandalone()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIndent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndent</h4> |
| <pre>public boolean getIndent()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the output document should be indented to visually |
| indicate its structure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMediaType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMediaType</h4> |
| <pre>public java.lang.String getMediaType()</pre> |
| <div class="block">Gets the mediatype the media-type or MIME type associated with the output |
| document.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the mediatype the media-type or MIME type associated with the |
| output document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersion</h4> |
| <pre>public java.lang.String getVersion()</pre> |
| <div class="block">Gets the version of the output format.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the version of the output format.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVersion-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre>public void setVersion(java.lang.String version)</pre> |
| <div class="block">Sets the value coming from the xsl:output version attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - the version of the output format.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>XSLOutputAttributes.setVersion(String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMediaType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMediaType</h4> |
| <pre>public void setMediaType(java.lang.String mediaType)</pre> |
| <div class="block">Sets the value coming from the xsl:output media-type stylesheet attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mediaType</code> - the non-null media-type or MIME type associated with the |
| output document.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>OutputKeys.MEDIA_TYPE</code>, |
| <code>XSLOutputAttributes.setMediaType(String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIndentAmount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndentAmount</h4> |
| <pre>public int getIndentAmount()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of spaces to indent for each indentation level.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIndentAmount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndentAmount</h4> |
| <pre>public void setIndentAmount(int m_indentAmount)</pre> |
| <div class="block">Sets the indentation amount.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setIndentAmount-int-">setIndentAmount</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>m_indentAmount</code> - The m_indentAmount to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIndent-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndent</h4> |
| <pre>public void setIndent(boolean doIndent)</pre> |
| <div class="block">Sets the value coming from the xsl:output indent stylesheet |
| attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>doIndent</code> - true if the output document should be indented to |
| visually indicate its structure.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>XSLOutputAttributes.setIndent(boolean)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="namespaceAfterStartElement-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>namespaceAfterStartElement</h4> |
| <pre>public void namespaceAfterStartElement(java.lang.String uri, |
| java.lang.String prefix) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">This method is used when a prefix/uri namespace mapping |
| is indicated after the element was started with a |
| startElement() and before and endElement(). |
| startPrefixMapping(prefix,uri) would be used before the |
| startElement() call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#namespaceAfterStartElement-java.lang.String-java.lang.String-">namespaceAfterStartElement</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - the URI of the namespace</dd> |
| <dd><code>prefix</code> - the prefix associated with the given URI.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#namespaceAfterStartElement-java.lang.String-java.lang.String-"><code>ExtendedContentHandler.namespaceAfterStartElement(String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asDOMSerializer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asDOMSerializer</h4> |
| <pre>public <a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer">DOMSerializer</a> asDOMSerializer() |
| throws java.io.IOException</pre> |
| <div class="block">Return a <a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><code>DOMSerializer</code></a> interface into this serializer. If the |
| serializer does not support the <a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><code>DOMSerializer</code></a> interface, it should |
| return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/Serializer.html#asDOMSerializer--">asDOMSerializer</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer">Serializer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><code>DOMSerializer</code></a> interface into this serializer, or null |
| if the serializer is not DOM capable</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - An I/O exception occured</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/Serializer.html#asDOMSerializer--"><code>Serializer.asDOMSerializer()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrefixPart-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefixPart</h4> |
| <pre>protected static final java.lang.String getPrefixPart(java.lang.String qname)</pre> |
| <div class="block">Returns the local name of a qualified name. |
| If the name has no prefix, |
| then it works as the identity (SAX2).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - a qualified name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns the prefix of the qualified name, |
| or null if there is no prefix.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespaceMappings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamespaceMappings</h4> |
| <pre>public <a href="../../../../org/apache/xml/serializer/NamespaceMappings.html" title="class in org.apache.xml.serializer">NamespaceMappings</a> getNamespaceMappings()</pre> |
| <div class="block">Some users of the serializer may need the current namespace mappings.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#getNamespaceMappings--">getNamespaceMappings</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current namespace mappings (prefix/uri)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#getNamespaceMappings--"><code>ExtendedContentHandler.getNamespaceMappings()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrefix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefix</h4> |
| <pre>public java.lang.String getPrefix(java.lang.String namespaceURI)</pre> |
| <div class="block">Returns the prefix currently pointing to the given URI (if any).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#getPrefix-java.lang.String-">getPrefix</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespaceURI</code> - the uri of the namespace in question</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a prefix pointing to the given URI (if any).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#getPrefix-java.lang.String-"><code>ExtendedContentHandler.getPrefix(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespaceURI-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamespaceURI</h4> |
| <pre>public java.lang.String getNamespaceURI(java.lang.String qname, |
| boolean isElement)</pre> |
| <div class="block">Returns the URI of an element or attribute. Note that default namespaces |
| do not apply directly to attributes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#getNamespaceURI-java.lang.String-boolean-">getNamespaceURI</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qname</code> - a qualified name</dd> |
| <dd><code>isElement</code> - true if the qualified name is the name of |
| an element.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns the namespace URI associated with the qualified name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespaceURIFromPrefix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamespaceURIFromPrefix</h4> |
| <pre>public java.lang.String getNamespaceURIFromPrefix(java.lang.String prefix)</pre> |
| <div class="block">Returns the URI of prefix (if any).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#getNamespaceURIFromPrefix-java.lang.String-">getNamespaceURIFromPrefix</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - the prefix whose URI is searched for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the namespace URI currently associated with the |
| prefix, null if the prefix is undefined.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entityReference-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entityReference</h4> |
| <pre>public void entityReference(java.lang.String name) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Entity reference event.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#entityReference-java.lang.String-">entityReference</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of entity</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTransformer-javax.xml.transform.Transformer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransformer</h4> |
| <pre>public void setTransformer(javax.xml.transform.Transformer t)</pre> |
| <div class="block">Sets the transformer associated with this serializer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setTransformer-javax.xml.transform.Transformer-">setTransformer</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>t</code> - the transformer associated with this serializer.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setTransformer-javax.xml.transform.Transformer-"><code>SerializationHandler.setTransformer(Transformer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransformer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransformer</h4> |
| <pre>public javax.xml.transform.Transformer getTransformer()</pre> |
| <div class="block">Gets the transformer associated with this serializer</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#getTransformer--">getTransformer</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>returns the transformer associated with this serializer.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#getTransformer--"><code>SerializationHandler.getTransformer()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="characters-org.w3c.dom.Node-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>characters</h4> |
| <pre>public void characters(org.w3c.dom.Node node) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">This method gets the nodes value as a String and uses that String as if |
| it were an input character notification.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#characters-org.w3c.dom.Node-">characters</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>node</code> - the Node to serialize</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="error-org.xml.sax.SAXParseException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>error</h4> |
| <pre>public void error(org.xml.sax.SAXParseException exc) |
| throws org.xml.sax.SAXException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>error</code> in interface <code>org.xml.sax.ErrorHandler</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ErrorHandler.error(SAXParseException)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fatalError-org.xml.sax.SAXParseException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fatalError</h4> |
| <pre>public void fatalError(org.xml.sax.SAXParseException exc) |
| throws org.xml.sax.SAXException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>fatalError</code> in interface <code>org.xml.sax.ErrorHandler</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ErrorHandler.fatalError(SAXParseException)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="warning-org.xml.sax.SAXParseException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>warning</h4> |
| <pre>public void warning(org.xml.sax.SAXParseException exc) |
| throws org.xml.sax.SAXException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>warning</code> in interface <code>org.xml.sax.ErrorHandler</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ErrorHandler.warning(SAXParseException)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitStartEntity-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitStartEntity</h4> |
| <pre>protected void emitStartEntity(java.lang.String name) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit start entity trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of entity</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitCDATAEvent-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitCDATAEvent</h4> |
| <pre>protected void emitCDATAEvent(char[] chars, |
| int start, |
| int length) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Report the CDATA trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chars</code> - content of CDATA</dd> |
| <dd><code>start</code> - starting index of characters to output</dd> |
| <dd><code>length</code> - number of characters to output</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitCommentEvent-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitCommentEvent</h4> |
| <pre>protected void emitCommentEvent(char[] chars, |
| int start, |
| int length) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Report the comment trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chars</code> - content of comment</dd> |
| <dd><code>start</code> - starting index of comment to output</dd> |
| <dd><code>length</code> - number of characters to output</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitEndEntity-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitEndEntity</h4> |
| <pre>public void emitEndEntity(java.lang.String name) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit an end entity trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of entity</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitStartDoc--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitStartDoc</h4> |
| <pre>protected void emitStartDoc() |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit start document trace event.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitEndDoc--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitEndDoc</h4> |
| <pre>protected void emitEndDoc() |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit an end document trace event.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitStartElem-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitStartElem</h4> |
| <pre>protected void emitStartElem(java.lang.String elemName) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Report the start element trace event. This trace method needs to be |
| called just before the attributes are cleared.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>elemName</code> - the qualified name of the element</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitEscapingEvent-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitEscapingEvent</h4> |
| <pre>protected void emitEscapingEvent(java.lang.String name, |
| java.lang.String data) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit an PI trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of PI</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emitEntityReference-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emitEntityReference</h4> |
| <pre>protected void emitEntityReference(java.lang.String name) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Emit an entity reference trace event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of entity reference</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startDocument--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startDocument</h4> |
| <pre>public void startDocument() |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">Receive notification of the beginning of a document. |
| This method is never a self generated call, |
| but only called externally. |
| |
| <p>The SAX parser will invoke this method only once, before any |
| other methods in this interface or in DTDHandler (except for |
| setDocumentLocator).</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>startDocument</code> in interface <code>org.xml.sax.ContentHandler</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code> - Any SAX exception, possibly |
| wrapping another exception.</dd> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startDocumentInternal--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startDocumentInternal</h4> |
| <pre>protected void startDocumentInternal() |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">This method handles what needs to be done at a startDocument() call, |
| whether from an external caller, or internally called in the |
| serializer. For historical reasons the serializer is flexible to |
| startDocument() not always being called. |
| Even if no external call is |
| made into startDocument() this method will always be called as a self |
| generated internal startDocument, it handles what needs to be done at a |
| startDocument() call. |
| |
| This method exists just to make sure that startDocument() is only ever |
| called from an external caller, which in principle is just a matter of |
| style.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSourceLocator-javax.xml.transform.SourceLocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSourceLocator</h4> |
| <pre>public void setSourceLocator(javax.xml.transform.SourceLocator locator)</pre> |
| <div class="block">This method is used to set the source locator, which might be used to |
| generated an error message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#setSourceLocator-javax.xml.transform.SourceLocator-">setSourceLocator</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>locator</code> - the source locator</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#setSourceLocator-javax.xml.transform.SourceLocator-"><code>ExtendedContentHandler.setSourceLocator(javax.xml.transform.SourceLocator)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNamespaceMappings-org.apache.xml.serializer.NamespaceMappings-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNamespaceMappings</h4> |
| <pre>public void setNamespaceMappings(<a href="../../../../org/apache/xml/serializer/NamespaceMappings.html" title="class in org.apache.xml.serializer">NamespaceMappings</a> mappings)</pre> |
| <div class="block">Used only by TransformerSnapshotImpl to restore the serialization |
| to a previous state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setNamespaceMappings-org.apache.xml.serializer.NamespaceMappings-">setNamespaceMappings</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mappings</code> - NamespaceMappings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public boolean reset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/xml/serializer/Serializer.html#reset--">Serializer</a></code></span></div> |
| <div class="block">This method resets the serializer. |
| If this method returns true, the |
| serializer may be used for subsequent serialization of new |
| documents. It is possible to change the output format and |
| output stream prior to serializing, or to reuse the existing |
| output format and output stream or writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/Serializer.html#reset--">reset</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer">Serializer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if serializer has been reset and can be reused</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre>public void addAttribute(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value) |
| throws org.xml.sax.SAXException</pre> |
| <div class="block">This method adds an attribute the the current element, |
| but should not be used for an xsl:attribute child.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">addAttribute</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer">ExtendedContentHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - the namespace URI of the attribute name</dd> |
| <dd><code>localName</code> - the local name of the attribute (without prefix)</dd> |
| <dd><code>rawName</code> - the qualified name of the attribute</dd> |
| <dd><code>type</code> - the attribute type typically character data (CDATA)</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#addAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"><code>ExtendedContentHandler.addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="notationDecl-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notationDecl</h4> |
| <pre>public void notationDecl(java.lang.String arg0, |
| java.lang.String arg1, |
| java.lang.String arg2) |
| throws org.xml.sax.SAXException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>notationDecl</code> in interface <code>org.xml.sax.DTDHandler</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unparsedEntityDecl-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unparsedEntityDecl</h4> |
| <pre>public void unparsedEntityDecl(java.lang.String arg0, |
| java.lang.String arg1, |
| java.lang.String arg2, |
| java.lang.String arg3) |
| throws org.xml.sax.SAXException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>unparsedEntityDecl</code> in interface <code>org.xml.sax.DTDHandler</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.xml.sax.SAXException</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDTDEntityExpansion-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDTDEntityExpansion</h4> |
| <pre>public void setDTDEntityExpansion(boolean expand)</pre> |
| <div class="block">If set to false the serializer does not expand DTD entities, |
| but leaves them as is, the default value is true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setDTDEntityExpansion-boolean-">setDTDEntityExpansion</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expand</code> - true if DTD entities are to be expanded, |
| false if they are to be left as DTD entity references.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="documentIsEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>documentIsEmpty</h4> |
| <pre>public boolean documentIsEmpty()</pre> |
| <div class="block">Return true if nothing has been sent to this result tree yet. |
| <p> |
| This is not a public API.</div> |
| </li> |
| </ul> |
| <a name="isCdataSection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCdataSection</h4> |
| <pre>protected boolean isCdataSection()</pre> |
| <div class="block">Return true if the current element in m_elemContext |
| is a CDATA section. |
| CDATA sections are specified in the <xsl:output> attribute |
| cdata-section-names or in the JAXP equivalent property. |
| In any case the format of the value of such a property is: |
| <pre> |
| "{uri1}localName1 {uri2}localName2 . . . " |
| </pre> |
| |
| <p> |
| This method is not a public API, but is only used internally by the serializer.</div> |
| </li> |
| </ul> |
| <a name="getOutputProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputProperty</h4> |
| <pre>public java.lang.String getOutputProperty(java.lang.String name)</pre> |
| <div class="block">Get the value of an output property, |
| the explicit value, if any, otherwise the |
| default value, if any, otherwise null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the property, which is just the local name |
| if it is in no namespace, but is the URI in curly braces followed by |
| the local name if it is in a namespace, for example: |
| <ul> |
| <li> "encoding" |
| <li> "method" |
| <li> "{http://xml.apache.org/xalan}indent-amount" |
| <li> "{http://xml.apache.org/xalan}line-separator" |
| </ul></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value of the parameter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputPropertyNonDefault-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputPropertyNonDefault</h4> |
| <pre>public java.lang.String getOutputPropertyNonDefault(java.lang.String name)</pre> |
| <div class="block">Get the value of an output property, |
| not the default value. If there is a default |
| value, but no non-default value this method |
| will return null. |
| <p></div> |
| </li> |
| </ul> |
| <a name="asDOM3Serializer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asDOM3Serializer</h4> |
| <pre>public java.lang.Object asDOM3Serializer() |
| throws java.io.IOException</pre> |
| <div class="block">Return a <a href="../../../../org/apache/xml/serializer/DOM3Serializer.html" title="interface in org.apache.xml.serializer"><code>DOM3Serializer</code></a> interface into this serializer. If the |
| serializer does not support the <a href="../../../../org/apache/xml/serializer/DOM3Serializer.html" title="interface in org.apache.xml.serializer"><code>DOM3Serializer</code></a> interface, it should |
| return null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/Serializer.html#asDOM3Serializer--">asDOM3Serializer</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer">Serializer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../org/apache/xml/serializer/DOM3Serializer.html" title="interface in org.apache.xml.serializer"><code>DOM3Serializer</code></a> interface into this serializer, or null |
| if the serializer is not DOM capable</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - An I/O exception occured</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/xml/serializer/Serializer.html#asDOM3Serializer--"><code>Serializer.asDOM3Serializer()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputPropertyDefault-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputPropertyDefault</h4> |
| <pre>public java.lang.String getOutputPropertyDefault(java.lang.String name)</pre> |
| <div class="block">Get the default value of an xsl:output property, |
| which would be null only if no default value exists |
| for the property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the property.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The default value of the parameter, or null if there is no default value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOutputProperty-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputProperty</h4> |
| <pre>public void setOutputProperty(java.lang.String name, |
| java.lang.String val)</pre> |
| <div class="block">Set the value for the output property, typically from |
| an xsl:output element, but this does not change what |
| the default value is.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the property, which is just the local name |
| if it is in no namespace, but is the URI in curly braces followed by |
| the local name if it is in a namespace, for example: |
| <ul> |
| <li> "encoding" |
| <li> "method" |
| <li> "{http://xml.apache.org/xalan}indent-amount" |
| <li> "{http://xml.apache.org/xalan}line-separator" |
| </ul></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOutputPropertyDefault-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputPropertyDefault</h4> |
| <pre>public void setOutputPropertyDefault(java.lang.String name, |
| java.lang.String val)</pre> |
| <div class="block">Set the default value for an output property, but this does |
| not impact any explicitly set value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the property, which is just the local name |
| if it is in no namespace, but is the URI in curly braces followed by |
| the local name if it is in a namespace, for example: |
| <ul> |
| <li> "encoding" |
| <li> "method" |
| <li> "{http://xml.apache.org/xalan}indent-amount" |
| <li> "{http://xml.apache.org/xalan}line-separator" |
| </ul></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCharMapConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharMapConfig</h4> |
| <pre>public <a href="../../../../org/apache/xml/serializer/CharacterMapConfig.html" title="class in org.apache.xml.serializer">CharacterMapConfig</a> getCharMapConfig()</pre> |
| <div class="block">Get xsl:character-map run-time configuration object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An CharacterMapConfig object instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCharMapConfig-org.apache.xml.serializer.CharacterMapConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCharMapConfig</h4> |
| <pre>public void setCharMapConfig(<a href="../../../../org/apache/xml/serializer/CharacterMapConfig.html" title="class in org.apache.xml.serializer">CharacterMapConfig</a> charMapConfig)</pre> |
| <div class="block">Set xsl:character-map run-time configuration object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>charMapConfig</code> - An CharacterMapConfig object instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOutputMethod-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputMethod</h4> |
| <pre>public void setOutputMethod(java.lang.String outputMethod)</pre> |
| <div class="block">Set XSL transform's xsl:output 'method' value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html#setOutputMethod-java.lang.String-">setOutputMethod</a></code> in interface <code><a href="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCdataSectionElements-java.util.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setCdataSectionElements</h4> |
| <pre>public void setCdataSectionElements(java.util.Vector URI_and_localNames)</pre> |
| <div class="block">Sets the value coming from the xsl:output cdata-section-elements |
| stylesheet property. |
| |
| This sets the elements whose text elements are to be output as CDATA |
| sections.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>URI_and_localNames</code> - pairs of namespace URI and local names that |
| identify elements whose text elements are to be output as CDATA sections. |
| The namespace of the local element must be the given URI to match. The |
| qName is not given because the prefix does not matter, only the namespace |
| URI to which that prefix would map matters, so the prefix itself is not |
| relevant in specifying which elements have their text to be output as |
| CDATA sections.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/xml/serializer/Serializer.html" title="interface in org.apache.xml.serializer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/xml/serializer/SerializerFactory.html" title="class in org.apache.xml.serializer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/xml/serializer/SerializerBase.html" target="_top">Frames</a></li> |
| <li><a href="SerializerBase.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |