| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>AbstractMarshallerImpl (EclipseLink 3.0.0, API Reference)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-04-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractMarshallerImpl (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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 class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.xml.bind.helpers</a></div> |
| <h2 title="Class AbstractMarshallerImpl" class="title">Class AbstractMarshallerImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.xml.bind.helpers.AbstractMarshallerImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractMarshallerImpl</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></pre> |
| <div class="block">Partial default <code>Marshaller</code> implementation. |
| |
| <p> |
| This class provides a partial default implementation for the |
| <a href="../Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a> interface. |
| |
| <p> |
| The only methods that a JAXB Provider has to implement are |
| <a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.transform.Result)"><code>marshal(Object, javax.xml.transform.Result)</code></a>, |
| <a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.transform.Result)"><code>marshal(Object, javax.xml.stream.XMLStreamWriter)</code></a>, and |
| <a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.transform.Result)"><code>marshal(Object, javax.xml.stream.XMLEventWriter)</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li></ul></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAXB 1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.jakarta.xml.bind.Marshaller"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface jakarta.xml.bind.<a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></h3> |
| <code><a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind">Marshaller.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.jakarta.xml.bind.Marshaller"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface jakarta.xml.bind.<a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></h3> |
| <code><a href="../Marshaller.html#JAXB_ENCODING">JAXB_ENCODING</a>, <a href="../Marshaller.html#JAXB_FORMATTED_OUTPUT">JAXB_FORMATTED_OUTPUT</a>, <a href="../Marshaller.html#JAXB_FRAGMENT">JAXB_FRAGMENT</a>, <a href="../Marshaller.html#JAXB_NO_NAMESPACE_SCHEMA_LOCATION">JAXB_NO_NAMESPACE_SCHEMA_LOCATION</a>, <a href="../Marshaller.html#JAXB_SCHEMA_LOCATION">JAXB_SCHEMA_LOCATION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractMarshallerImpl</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><A extends <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters">XmlAdapter</a>><br>A</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdapter(java.lang.Class)">getAdapter</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><A> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the adapter associated with the specified type.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../attachment/AttachmentMarshaller.html" title="class in jakarta.xml.bind.attachment">AttachmentMarshaller</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachmentMarshaller()">getAttachmentMarshaller</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEncoding()">getEncoding</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for getting the current output encoding.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventHandler()">getEventHandler</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current event handler or the default event handler if one |
| hasn't been set.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaEncoding(java.lang.String)">getJavaEncoding</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the corresponding Java encoding name from an IANA name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind">Marshaller.Listener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListener()">getListener</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind"><code>Marshaller.Listener</code></a> registered with this <a href="../Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Node</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNode(java.lang.Object)">getNode</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</code></th> |
| <td class="colLast"> |
| <div class="block">By default, the getNode method is unsupported and throw |
| an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>UnsupportedOperationException</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNoNSSchemaLocation()">getNoNSSchemaLocation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for getting the current noNamespaceSchemaLocation.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Default implementation of the getProperty method handles |
| the four defined properties in Marshaller.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink">Schema</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSchema()">getSchema</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the JAXP 1.3 <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink"><code>Schema</code></a> object |
| being used to perform marshal-time validation.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSchemaLocation()">getSchemaLocation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for getting the current schemaLocation.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFormattedOutput()">isFormattedOutput</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for getting the formatted output flag.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFragment()">isFragment</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for getting the fragment flag.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.io.File)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbElement, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> output)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a file.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.io.OutputStream)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> os)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into an output stream.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.io.Writer)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io" class="externalLink">Writer</a> w)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a Writer.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,javax.xml.stream.XMLEventWriter)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLEventWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLEventWriter</a> writer)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLEventWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink"><code>XMLEventWriter</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,javax.xml.stream.XMLStreamWriter)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamWriter</a> writer)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink"><code>XMLStreamWriter</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,org.w3c.dom.Node)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Node</a> node)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a DOM tree.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,org.xml.sax.ContentHandler)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ContentHandler.html?is-external=true" title="class or interface in org.xml.sax" class="externalLink">ContentHandler</a> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into SAX2 events.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)">setAdapter</a></span>​(<a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters">XmlAdapter</a> adapter)</code></th> |
| <td class="colLast"> |
| <div class="block">Associates a configured instance of <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this marshaller.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><A extends <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters">XmlAdapter</a>><br>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAdapter(java.lang.Class,A)">setAdapter</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><A> type, |
| A adapter)</code></th> |
| <td class="colLast"> |
| <div class="block">Associates a configured instance of <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this marshaller.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAttachmentMarshaller(jakarta.xml.bind.attachment.AttachmentMarshaller)">setAttachmentMarshaller</a></span>​(<a href="../attachment/AttachmentMarshaller.html" title="class in jakarta.xml.bind.attachment">AttachmentMarshaller</a> am)</code></th> |
| <td class="colLast"> |
| <div class="block">Associate a context that enables binary data within an XML document |
| to be transmitted as XML-binary optimized attachment.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEncoding(java.lang.String)">setEncoding</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for setting the output encoding.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEventHandler(jakarta.xml.bind.ValidationEventHandler)">setEventHandler</a></span>​(<a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Allow an application to register a validation event handler.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFormattedOutput(boolean)">setFormattedOutput</a></span>​(boolean v)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for setting the formatted output flag.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFragment(boolean)">setFragment</a></span>​(boolean v)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for setting the fragment flag.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setListener(jakarta.xml.bind.Marshaller.Listener)">setListener</a></span>​(<a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind">Marshaller.Listener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Register marshal event callback <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind"><code>Marshaller.Listener</code></a> with this <a href="../Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNoNSSchemaLocation(java.lang.String)">setNoNSSchemaLocation</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> location)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for setting the noNamespaceSchemaLocation.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProperty(java.lang.String,java.lang.Object)">setProperty</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Default implementation of the setProperty method handles |
| the four defined properties in Marshaller.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSchema(javax.xml.validation.Schema)">setSchema</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink">Schema</a> schema)</code></th> |
| <td class="colLast"> |
| <div class="block">Specify the JAXP 1.3 <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink"><code>Schema</code></a> |
| object that should be used to validate subsequent marshal operations |
| against.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSchemaLocation(java.lang.String)">setSchemaLocation</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> location)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for setting the schemaLocation.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.jakarta.xml.bind.Marshaller"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.xml.bind.<a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></h3> |
| <code><a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.transform.Result)">marshal</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractMarshallerImpl</h4> |
| <pre>public AbstractMarshallerImpl()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="marshal(java.lang.Object,java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public final void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> os) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,java.io.OutputStream)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into an output stream.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,java.io.OutputStream)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - The root of content tree to be marshalled.</dd> |
| <dd><code>os</code> - XML will be added to this stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbElement, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> output) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,java.io.File)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,java.io.File)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbElement</code> - The root of content tree to be marshalled.</dd> |
| <dd><code>output</code> - File to be written. If this file already exists, it will be overwritten.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.io.Writer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public final void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io" class="externalLink">Writer</a> w) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,java.io.Writer)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a Writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,java.io.Writer)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - The root of content tree to be marshalled.</dd> |
| <dd><code>w</code> - XML will be sent to this writer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,org.xml.sax.ContentHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public final void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/org/xml/sax/ContentHandler.html?is-external=true" title="class or interface in org.xml.sax" class="externalLink">ContentHandler</a> handler) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,org.xml.sax.ContentHandler)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into SAX2 events.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,org.xml.sax.ContentHandler)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - The root of content tree to be marshalled.</dd> |
| <dd><code>handler</code> - XML will be sent to this handler as SAX2 events.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,org.w3c.dom.Node)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public final void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Node</a> node) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,org.w3c.dom.Node)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a DOM tree.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,org.w3c.dom.Node)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - The content tree to be marshalled.</dd> |
| <dd><code>node</code> - DOM nodes will be added as children of this node. |
| This parameter must be a Node that accepts children |
| (<a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Document</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/DocumentFragment.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>DocumentFragment</code></a>, or |
| <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a>)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNode(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNode</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Node</a> getNode​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block">By default, the getNode method is unsupported and throw |
| an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>UnsupportedOperationException</code></a>. |
| |
| Implementations that choose to support this method must |
| override this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getNode(java.lang.Object)">getNode</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - - JAXB Java representation of XML content</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the DOM tree view of the contentTree</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEncoding()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncoding</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getEncoding()</pre> |
| <div class="block">Convenience method for getting the current output encoding.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current encoding or "UTF-8" if it hasn't been set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEncoding(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncoding</h4> |
| <pre class="methodSignature">protected void setEncoding​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</pre> |
| <div class="block">Convenience method for setting the output encoding.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoding</code> - a valid encoding as specified in the Marshaller class |
| documentation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSchemaLocation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaLocation</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getSchemaLocation()</pre> |
| <div class="block">Convenience method for getting the current schemaLocation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current schemaLocation or null if it hasn't been set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSchemaLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaLocation</h4> |
| <pre class="methodSignature">protected void setSchemaLocation​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> location)</pre> |
| <div class="block">Convenience method for setting the schemaLocation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>location</code> - the schemaLocation value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNoNSSchemaLocation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNoNSSchemaLocation</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getNoNSSchemaLocation()</pre> |
| <div class="block">Convenience method for getting the current noNamespaceSchemaLocation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current noNamespaceSchemaLocation or null if it hasn't |
| been set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNoNSSchemaLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoNSSchemaLocation</h4> |
| <pre class="methodSignature">protected void setNoNSSchemaLocation​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> location)</pre> |
| <div class="block">Convenience method for setting the noNamespaceSchemaLocation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>location</code> - the noNamespaceSchemaLocation value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFormattedOutput()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFormattedOutput</h4> |
| <pre class="methodSignature">protected boolean isFormattedOutput()</pre> |
| <div class="block">Convenience method for getting the formatted output flag.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current value of the formatted output flag or false if |
| it hasn't been set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFormattedOutput(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFormattedOutput</h4> |
| <pre class="methodSignature">protected void setFormattedOutput​(boolean v)</pre> |
| <div class="block">Convenience method for setting the formatted output flag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>v</code> - value of the formatted output flag.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFragment()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFragment</h4> |
| <pre class="methodSignature">protected boolean isFragment()</pre> |
| <div class="block">Convenience method for getting the fragment flag.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current value of the fragment flag or false if |
| it hasn't been set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFragment(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFragment</h4> |
| <pre class="methodSignature">protected void setFragment​(boolean v)</pre> |
| <div class="block">Convenience method for setting the fragment flag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>v</code> - value of the fragment flag.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getJavaEncoding(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaEncoding</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getJavaEncoding​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io" class="externalLink">UnsupportedEncodingException</a></pre> |
| <div class="block">Gets the corresponding Java encoding name from an IANA name. |
| |
| This method is a helper method for the derived class to convert |
| encoding names.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io" class="externalLink">UnsupportedEncodingException</a></code> - If this implementation couldn't find the Java encoding name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProperty(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre class="methodSignature">public void setProperty​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value) |
| throws <a href="../PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></pre> |
| <div class="block">Default implementation of the setProperty method handles |
| the four defined properties in Marshaller. If a provider |
| needs to handle additional properties, it should override |
| this method in a derived class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setProperty(java.lang.String,java.lang.Object)">setProperty</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the property to be set. This value can either |
| be specified using one of the constant fields or a user |
| supplied string.</dd> |
| <dd><code>value</code> - the value of the property to be set</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></code> - when there is an error processing the given |
| property or value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getProperty​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name) |
| throws <a href="../PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></pre> |
| <div class="block">Default implementation of the getProperty method handles |
| the four defined properties in Marshaller. If a provider |
| needs to support additional provider specific properties, |
| it should override this method in a derived class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getProperty(java.lang.String)">getProperty</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the property to retrieve</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the requested property</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></code> - when there is an error retrieving the given property or value |
| property name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEventHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventHandler</h4> |
| <pre class="methodSignature">public <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a> getEventHandler() |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#getEventHandler()">Marshaller</a></code></span></div> |
| <div class="block">Return the current event handler or the default event handler if one |
| hasn't been set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getEventHandler()">getEventHandler</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current ValidationEventHandler or the default event handler |
| if it hasn't been set</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - if an error was encountered while getting the |
| current event handler</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Marshaller.html#getEventHandler()"><code>Marshaller.getEventHandler()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEventHandler(jakarta.xml.bind.ValidationEventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEventHandler</h4> |
| <pre class="methodSignature">public void setEventHandler​(<a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a> handler) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#setEventHandler(jakarta.xml.bind.ValidationEventHandler)">Marshaller</a></code></span></div> |
| <div class="block">Allow an application to register a validation event handler. |
| <p> |
| The validation event handler will be called by the JAXB Provider if any |
| validation errors are encountered during calls to any of the marshal |
| API's. If the client application does not register a validation event |
| handler before invoking one of the marshal methods, then validation |
| events will be handled by the default event handler which will terminate |
| the marshal operation after the first error or fatal error is encountered. |
| <p> |
| Calling this method with a null parameter will cause the Marshaller |
| to revert back to the default default event handler.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setEventHandler(jakarta.xml.bind.ValidationEventHandler)">setEventHandler</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handler</code> - the validation event handler</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - if an error was encountered while setting the |
| event handler</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Marshaller.html#setEventHandler(jakarta.xml.bind.ValidationEventHandler)"><code>Marshaller.setEventHandler(ValidationEventHandler)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,javax.xml.stream.XMLEventWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLEventWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLEventWriter</a> writer) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.stream.XMLEventWriter)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLEventWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink"><code>XMLEventWriter</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.stream.XMLEventWriter)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - The content tree rooted at jaxbElement to be marshalled.</dd> |
| <dd><code>writer</code> - XML will be sent to this writer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,javax.xml.stream.XMLStreamWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamWriter</a> writer) |
| throws <a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.stream.XMLStreamWriter)">Marshaller</a></code></span></div> |
| <div class="block">Marshal the content tree rooted at <code>jaxbElement</code> into a |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink"><code>XMLStreamWriter</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#marshal(java.lang.Object,javax.xml.stream.XMLStreamWriter)">marshal</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - The content tree to be marshalled.</dd> |
| <dd><code>writer</code> - XML will be sent to this writer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></code> - If any unexpected problem occurs during the marshalling.</dd> |
| <dd><code><a href="../MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></code> - If the <a href="../ValidationEventHandler.html" title="interface in jakarta.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <code>handleEvent</code> method or the |
| <code>Marshaller</code> is unable to marshal <code>jaxbElement</code> (or any |
| object reachable from <code>jaxbElement</code>). See <a href="#elementMarshalling"> |
| Marshalling a JAXB element</a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSchema(javax.xml.validation.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchema</h4> |
| <pre class="methodSignature">public void setSchema​(<a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink">Schema</a> schema)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#setSchema(javax.xml.validation.Schema)">Marshaller</a></code></span></div> |
| <div class="block">Specify the JAXP 1.3 <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink"><code>Schema</code></a> |
| object that should be used to validate subsequent marshal operations |
| against. Passing null into this method will disable validation. |
| |
| <p> |
| This method allows the caller to validate the marshalled XML as it's marshalled. |
| |
| <p> |
| Initially this property is set to <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setSchema(javax.xml.validation.Schema)">setSchema</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - Schema object to validate marshal operations against or null to disable validation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink">Schema</a> getSchema()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#getSchema()">Marshaller</a></code></span></div> |
| <div class="block">Get the JAXP 1.3 <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/validation/Schema.html?is-external=true" title="class or interface in javax.xml.validation" class="externalLink"><code>Schema</code></a> object |
| being used to perform marshal-time validation. If there is no |
| Schema set on the marshaller, then this method will return null |
| indicating that marshal-time validation will not be performed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getSchema()">getSchema</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Schema object being used to perform marshal-time |
| validation or null if not present.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdapter</h4> |
| <pre class="methodSignature">public void setAdapter​(<a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters">XmlAdapter</a> adapter)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)">Marshaller</a></code></span></div> |
| <div class="block">Associates a configured instance of <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this marshaller. |
| |
| <p> |
| This is a convenience method that invokes <code>setAdapter(adapter.getClass(),adapter);</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)">setAdapter</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Marshaller.html#setAdapter(java.lang.Class,A)"><code>Marshaller.setAdapter(Class,XmlAdapter)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAdapter(java.lang.Class,jakarta.xml.bind.annotation.adapters.XmlAdapter)"> |
| <!-- --> |
| </a><a id="setAdapter(java.lang.Class,A)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdapter</h4> |
| <pre class="methodSignature">public <A extends <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters">XmlAdapter</a>> void setAdapter​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><A> type, |
| A adapter)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#setAdapter(java.lang.Class,A)">Marshaller</a></code></span></div> |
| <div class="block">Associates a configured instance of <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this marshaller. |
| |
| <p> |
| Every marshaller internally maintains a |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Class</code></a>,<a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a>>, |
| which it uses for marshalling classes whose fields/methods are annotated |
| with <a href="../annotation/adapters/XmlJavaTypeAdapter.html" title="annotation in jakarta.xml.bind.annotation.adapters"><code>XmlJavaTypeAdapter</code></a>. |
| |
| <p> |
| This method allows applications to use a configured instance of <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a>. |
| When an instance of an adapter is not given, a marshaller will create |
| one by invoking its default constructor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setAdapter(java.lang.Class,A)">setAdapter</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - The type of the adapter. The specified instance will be used when |
| <a href="../annotation/adapters/XmlJavaTypeAdapter.html#value()"><code>XmlJavaTypeAdapter.value()</code></a> |
| refers to this type.</dd> |
| <dd><code>adapter</code> - The instance of the adapter to be used. If null, it will un-register |
| the current adapter set for this type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAdapter(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapter</h4> |
| <pre class="methodSignature">public <A extends <a href="../annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters">XmlAdapter</a>> A getAdapter​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><A> type)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#getAdapter(java.lang.Class)">Marshaller</a></code></span></div> |
| <div class="block">Gets the adapter associated with the specified type. |
| |
| This is the reverse operation of the <a href="../Marshaller.html#setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)"><code>Marshaller.setAdapter(jakarta.xml.bind.annotation.adapters.XmlAdapter)</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getAdapter(java.lang.Class)">getAdapter</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAttachmentMarshaller(jakarta.xml.bind.attachment.AttachmentMarshaller)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttachmentMarshaller</h4> |
| <pre class="methodSignature">public void setAttachmentMarshaller​(<a href="../attachment/AttachmentMarshaller.html" title="class in jakarta.xml.bind.attachment">AttachmentMarshaller</a> am)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#setAttachmentMarshaller(jakarta.xml.bind.attachment.AttachmentMarshaller)">Marshaller</a></code></span></div> |
| <div class="block"><p>Associate a context that enables binary data within an XML document |
| to be transmitted as XML-binary optimized attachment. |
| The attachment is referenced from the XML document content model |
| by content-id URIs(cid) references stored within the xml document.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setAttachmentMarshaller(jakarta.xml.bind.attachment.AttachmentMarshaller)">setAttachmentMarshaller</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttachmentMarshaller()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachmentMarshaller</h4> |
| <pre class="methodSignature">public <a href="../attachment/AttachmentMarshaller.html" title="class in jakarta.xml.bind.attachment">AttachmentMarshaller</a> getAttachmentMarshaller()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getAttachmentMarshaller()">getAttachmentMarshaller</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setListener(jakarta.xml.bind.Marshaller.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setListener</h4> |
| <pre class="methodSignature">public void setListener​(<a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind">Marshaller.Listener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#setListener(jakarta.xml.bind.Marshaller.Listener)">Marshaller</a></code></span></div> |
| <div class="block"><p> |
| Register marshal event callback <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind"><code>Marshaller.Listener</code></a> with this <a href="../Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a>. |
| |
| <p> |
| There is only one Listener per Marshaller. Setting a Listener replaces the previous set Listener. |
| One can unregister current Listener by setting listener to <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#setListener(jakarta.xml.bind.Marshaller.Listener)">setListener</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - an instance of a class that implements <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind"><code>Marshaller.Listener</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getListener</h4> |
| <pre class="methodSignature">public <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind">Marshaller.Listener</a> getListener()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Marshaller.html#getListener()">Marshaller</a></code></span></div> |
| <div class="block"><p>Return <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind"><code>Marshaller.Listener</code></a> registered with this <a href="../Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Marshaller.html#getListener()">getListener</a></code> in interface <code><a href="../Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>registered <a href="../Marshaller.Listener.html" title="class in jakarta.xml.bind"><code>Marshaller.Listener</code></a> or <code>null</code> |
| if no Listener is registered with this Marshaller.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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 class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2017–2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |